accented 0.0.0-20250303013509 → 0.0.0-20250424114613

package/src/fullscreen-listener.ts

@@ -0,0 +1,17 @@
+import logAndRethrow from './log-and-rethrow.js';
+import recalculatePositions from './utils/recalculate-positions.js';
+
+export default function setupResizeListener() {
+  const abortController = new AbortController();
+  window.addEventListener('fullscreenchange', () => {
+    try {
+      recalculatePositions();
+    } catch (error) {
+      logAndRethrow(error);
+    }
+  }, { signal: abortController.signal });
+
+  return () => {
+    abortController.abort();
+  };
+};

package/src/logger.ts

@@ -1,6 +1,11 @@
 import { effect } from '@preact/signals-core';
 import { elementsWithIssues, enabled } from './state.js';
 import { accentedUrl } from './constants.js';
+import type { ElementWithIssues } from './types';
+
+function filterPropsForOutput(elements: Array<ElementWithIssues>) {
+  return elements.map(({ element, issues }) => ({ element, issues }));
+}
 
 export default function createLogger() {
 
@@ -14,7 +19,10 @@ export default function createLogger() {
     const elementCount = elementsWithIssues.value.length;
     if (elementCount > 0) {
       const issueCount = elementsWithIssues.value.reduce((acc, { issues }) => acc + issues.length, 0);
-      console.log(`${issueCount} accessibility issue${issueCount === 1 ? '' : 's'} found in ${elementCount} element${issueCount === 1 ? '' : 's'} (Accented, ${accentedUrl}):\n`, elementsWithIssues.value);
+      console.log(
+        `${issueCount} accessibility issue${issueCount === 1 ? '' : 's'} found in ${elementCount} element${issueCount === 1 ? '' : 's'} (Accented, ${accentedUrl}):\n`,
+        filterPropsForOutput(elementsWithIssues.value)
+      );
     } else {
       if (firstRun) {
         firstRun = false;

package/src/scanner.ts

@@ -1,18 +1,20 @@
 import axe from 'axe-core';
 import TaskQueue from './task-queue.js';
 import { elementsWithIssues, enabled, extendedElementsWithIssues } from './state.js';
-import type { AxeOptions, Throttle, Callback, AxeContext } from './types';
+import type { AxeOptions, Throttle, Callback, Context } from './types';
 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 { getAccentedElementNames, issuesUrl } from './constants.js';
 import logAndRethrow from './log-and-rethrow.js';
+import createShadowDOMAwareMutationObserver from './utils/shadow-dom-aware-mutation-observer.js';
+import getScanContext from './utils/get-scan-context.js';
 
-export default function createScanner(name: string, axeContext: AxeContext, axeOptions: AxeOptions, throttle: Required<Throttle>, callback: Callback) {
+export default function createScanner(name: string, context: Context, axeOptions: AxeOptions, throttle: Required<Throttle>, callback: Callback) {
   const axeRunningWindowProp = `__${name}_axe_running__`;
   const win: Record<string, any> = window;
-  const taskQueue = new TaskQueue<Node>(async () => {
+  const taskQueue = new TaskQueue<Node>(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.
@@ -22,16 +24,16 @@ export default function createScanner(name: string, axeContext: AxeContext, axeO
 
     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, {
           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
@@ -54,17 +56,37 @@ export default function createScanner(name: string, axeContext: AxeContext, axeO
       }
       win[axeRunningWindowProp] = false;
 
-      const axeMeasure = performance.measure('axe', 'axe-start');
+      const scanMeasure = performance.measure('scan', 'scan-start');
+      const scanDuration = Math.round(scanMeasure.duration);
 
       if (!enabled.value) {
         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({
         elementsWithIssues: elementsWithIssues.value,
-        scanDuration: Math.round(axeMeasure.duration)
+        performance: {
+          totalBlockingTime: scanDuration + domUpdateDuration,
+          scan: scanDuration,
+          domUpdate: domUpdateDuration,
+          // 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
+        }
       });
     } catch (error) {
       win[axeRunningWindowProp] = false;
@@ -72,13 +94,10 @@ export default function createScanner(name: string, axeContext: AxeContext, axeO
     }
   }, 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.
@@ -117,15 +136,13 @@ export default function createScanner(name: string, axeContext: AxeContext, axeO
         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,

package/src/state.ts

@@ -8,10 +8,18 @@ export const extendedElementsWithIssues = signal<Array<ExtendedElementWithIssues
 
 export const elementsWithIssues = computed<Array<ElementWithIssues>>(() => extendedElementsWithIssues.value.map(extendedElementWithIssues => ({
   element: extendedElementWithIssues.element,
+  rootNode: extendedElementWithIssues.rootNode,
   issues: extendedElementWithIssues.issues.value
 })));
 
-export const scrollableAncestors = computed<Set<HTMLElement>>(() =>
+export const rootNodes = computed<Set<Node>>(() =>
+  new Set(
+    (enabled.value ? [document as Node] : [])
+      .concat(...(extendedElementsWithIssues.value.map(extendedElementWithIssues => extendedElementWithIssues.rootNode)))
+  )
+);
+
+export const scrollableAncestors = computed<Set<Element>>(() =>
   extendedElementsWithIssues.value.reduce(
     (scrollableAncestors, extendedElementWithIssues) => {
       for (const scrollableAncestor of extendedElementWithIssues.scrollableAncestors.value) {
@@ -19,6 +27,6 @@ export const scrollableAncestors = computed<Set<HTMLElement>>(() =>
       }
       return scrollableAncestors;
     },
-    new Set<HTMLElement>()
+    new Set<Element>()
   )
 );

package/src/task-queue.ts

@@ -1,15 +1,15 @@
 import type { Throttle } from './types';
 
-type TaskCallback = () => void;
+type TaskCallback<T> = (items: Array<T>) => void;
 
 export default class TaskQueue<T> {
   #throttle: Throttle;
-  #asyncCallback: TaskCallback | null = null;
+  #asyncCallback: TaskCallback<T> | null = null;
 
   #items = new Set<T>();
   #inRunLoop = false;
 
-  constructor(asyncCallback: TaskCallback, throttle: Required<Throttle>) {
+  constructor(asyncCallback: TaskCallback<T>, throttle: Required<Throttle>) {
     this.#asyncCallback = asyncCallback;
     this.#throttle = throttle;
   }
@@ -33,10 +33,12 @@ export default class TaskQueue<T> {
       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));

package/src/types.ts

@@ -29,7 +29,31 @@ export type Output = {
   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>;
+
+// axe.SelectorList also can have FrameSelector elements in the array.
+// We're not allowing that.
+export type SelectorList = Array<Selector> | NodeList;
+
+// The rest of the type is structured the same as in axe-core.
+export type ContextProp = Selector | SelectorList;
+
+export type ContextObject = {
+  include: ContextProp;
+  exclude?: ContextProp;
+} | {
+  exclude: ContextProp;
+  include?: ContextProp;
+};
+
+export type Context = ContextProp | ContextObject;
+
+
 
 export const allowedAxeOptions = ['rules', 'runOnly'] as const;
 
@@ -42,9 +66,20 @@ type CallbackParams = {
   elementsWithIssues: Array<ElementWithIssues>,
 
   /**
-   * How long the scan took in milliseconds.
+   * * `performance`: runtime performance of the last scan. An object:
+   * * `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 the `scan` phase took, in milliseconds.
+   * * `domUpdate`: how long the `domUpdate` phase took, in milliseconds.
+   * * `scanContext`: nodes that got scanned. Either an array of nodes,
+   *   or an object with `include` and `exclude` properties (if any nodes were excluded).
    * */
-  scanDuration: number
+  performance: {
+    totalBlockingTime: number,
+    scan: number,
+    domUpdate: number,
+    scanContext: ScanContext | Array<Node>
+  }
 }
 
 export type Callback = (params: CallbackParams) => void;
@@ -67,7 +102,7 @@ export type AccentedOptions = {
    *
    * Default: `document`.
    */
-  axeContext?: AxeContext,
+  context?: Context,
 
   /**
    * The `options` parameter for `axe.run()`.
@@ -141,16 +176,27 @@ export type Issue = {
   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>
+};

package/src/utils/are-elements-with-issues-equal.ts

@@ -0,0 +1,9 @@
+import type { BaseElementWithIssues } from "../types";
+
+export default function areElementsWithIssuesEqual(
+  elementWithIssues1: BaseElementWithIssues,
+  elementWithIssues2: BaseElementWithIssues
+) {
+  return elementWithIssues1.element === elementWithIssues2.element
+    && elementWithIssues1.rootNode === elementWithIssues2.rootNode;
+}

package/src/utils/containing-blocks.ts

@@ -0,0 +1,57 @@
+/**
+ * Tests whether a particular combination of CSS property and value on an element
+ * makes that element a containing block.
+ * https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_display/Containing_block
+ *
+ * The function is meant to be run with properties that behave inconsistently across browsers.
+ *
+ * It's only meant to be used during initialization.
+ */
+function testContainingBlockCreation<T extends keyof CSSStyleDeclaration>(prop: T, value: CSSStyleDeclaration[T]) {
+  const container = document.createElement('div');
+  container.style[prop] = value;
+  container.style.position = 'fixed';
+  container.style.insetInlineStart = '10px';
+  container.style.insetBlockStart = '10px';
+
+  const element = document.createElement('div');
+  element.style.position = 'fixed';
+  element.style.insetInlineStart = '0';
+  element.style.insetBlockStart = '0';
+
+  container.appendChild(element);
+  document.body.appendChild(container);
+  const containerRect = container.getBoundingClientRect();
+  const elementRect = element.getBoundingClientRect();
+
+  container.remove();
+
+  return containerRect.top === elementRect.top && containerRect.left === elementRect.left;
+}
+
+// This is the set we'll use to store the properties that _may_ create containing blocks
+// (the behavior of the ones that we'll be checking is inconsistent across browsers
+// at the time of writing this comment).
+const propsAffectingContainingBlocks = new Set<keyof CSSStyleDeclaration>();
+
+export function createsContainingBlock(prop: keyof CSSStyleDeclaration) {
+  return propsAffectingContainingBlocks.has(prop);
+}
+
+export function initializeContainingBlockSupportSet() {
+  type StyleEntry<T extends keyof CSSStyleDeclaration> = {
+    [K in T]: { prop: K; value: CSSStyleDeclaration[K] }
+  }[T];
+
+  const propsToTest: Array<StyleEntry<'filter' | 'backdropFilter' | 'containerType'>> = [
+    { prop: 'filter', value: 'blur(1px)' },
+    { prop: 'backdropFilter', value: 'blur(1px)' },
+    { prop: 'containerType', value: 'size' }
+  ];
+
+  for (const { prop, value } of propsToTest) {
+    if (testContainingBlockCreation(prop, value)) {
+      propsAffectingContainingBlocks.add(prop);
+    }
+  }
+}

package/src/utils/contains.test.ts

@@ -0,0 +1,55 @@
+import { JSDOM } from 'jsdom';
+import assert from 'node:assert/strict';
+import { suite, test } from 'node:test';
+import contains from './contains';
+
+suite('contains', () => {
+  test('an element contains itself', () => {
+    const dom = new JSDOM('<div id="test"></div>');
+    const { document } = dom.window;
+    const element = document.querySelector('#test')!;
+
+    assert.equal(contains(element, element), true);
+  });
+
+  test('an element does not contain its sibling', () => {
+    const dom = new JSDOM('<div><div id="sibling1"></div><div id="sibling2"></div></div>');
+    const { document } = dom.window;
+    const sibling1 = document.querySelector('#sibling1')!;
+    const sibling2 = document.querySelector('#sibling2')!;
+
+    assert.equal(contains(sibling1, sibling2), false);
+  });
+
+  test('an element contain its descendant', () => {
+    const dom = new JSDOM('<div id="ancestor"><div id="descendant"></div></div>');
+    const { document } = dom.window;
+    const ancestor = document.querySelector('#ancestor')!;
+    const descendant = document.querySelector('#descendant')!;
+
+    assert.equal(contains(ancestor, descendant), true);
+  });
+
+  test('an element contain its descendant', () => {
+    const dom = new JSDOM('<div id="ancestor"><div id="descendant"></div></div>');
+    const { document } = dom.window;
+    const ancestor = document.querySelector('#ancestor')!;
+    const descendant = document.querySelector('#descendant')!;
+
+    assert.equal(contains(descendant, ancestor), false);
+  });
+
+  test('an element contain its descendant if the descendant is in a shadow DOM', () => {
+    const dom = new JSDOM('<div id="ancestor"><div id="host"></div></div>');
+    global.Node = dom.window.Node;
+    const { document } = dom.window;
+    const ancestor = document.querySelector('#ancestor')!;
+    const host = document.querySelector('#host')!;
+    const shadowRoot = host.attachShadow({ mode: 'open' });
+    shadowRoot.innerHTML = '<div id="descendant"></div>';
+    const descendant = shadowRoot.querySelector('#descendant')!;
+    console.log(descendant);
+
+    assert.equal(contains(ancestor, descendant), true);
+  });
+});

package/src/utils/contains.ts

@@ -0,0 +1,19 @@
+import { isDocumentFragment, isShadowRoot } from './dom-helpers.js';
+
+export default function contains(ancestor: Node, descendant: Node): boolean {
+  if (ancestor.contains(descendant)) {
+    return true;
+  }
+  let rootNode = descendant.getRootNode();
+  while (rootNode) {
+    if (!(isDocumentFragment(rootNode) && isShadowRoot(rootNode))) {
+      return false;
+    }
+    const host = rootNode.host;
+    if (ancestor.contains(host)) {
+      return true;
+    }
+    rootNode = host.getRootNode();
+  }
+  return false;
+}

package/src/utils/deduplicate-nodes.ts

@@ -0,0 +1,3 @@
+export function deduplicateNodes(nodes: Array<Node>): Array<Node> {
+  return [...new Set(nodes)];;
+}

package/src/utils/dom-helpers.ts

@@ -0,0 +1,38 @@
+export function isNode(obj: object): obj is Node {
+  return 'nodeType' in obj && typeof obj.nodeType === 'number' &&
+    'nodeName' in obj && typeof obj.nodeName === 'string';
+}
+
+export function isNodeList(obj: object): obj is NodeList {
+  return Object.prototype.toString.call(obj) === '[object NodeList]';
+}
+
+export function isElement(node: Node): node is Element {
+  return typeof Node !== 'undefined' && node.nodeType === Node.ELEMENT_NODE;
+}
+
+export function isDocument(node: Node): node is Document {
+  return typeof Node !== 'undefined' && node.nodeType === Node.DOCUMENT_NODE;
+}
+
+export function isDocumentFragment(node: Node): node is DocumentFragment {
+  return typeof Node !== 'undefined' && node.nodeType === Node.DOCUMENT_FRAGMENT_NODE;
+}
+
+export function isShadowRoot(documentFragment: DocumentFragment): documentFragment is ShadowRoot {
+  return 'host' in documentFragment;
+}
+
+export function isHtmlElement(element: Element): element is HTMLElement {
+  // We can't use instanceof because it may not work across contexts
+  // (such as when an element is moved from an iframe).
+  // This heuristic seems to be the most robust and fastest that I could think of.
+  return element.constructor.name.startsWith('HTML');
+}
+
+export function isSvgElement(element: Element): element is SVGElement {
+  // We can't use instanceof because it may not work across contexts
+  // (such as when an element is moved from an iframe).
+  // This heuristic seems to be the most robust and fastest that I could think of.
+  return element.constructor.name.startsWith('SVG');
+}

package/src/utils/ensure-non-empty.ts

@@ -0,0 +1,6 @@
+export default function ensureNonEmpty<T>(arr: T[]): [T, ...T[]] {
+  if (arr.length === 0) {
+    throw new Error("Array must not be empty");
+  }
+  return arr as [T, ...T[]];
+}

package/src/utils/get-element-position.ts

@@ -1,31 +1,50 @@
 import type { Position } from '../types';
-import isHtmlElement from './is-html-element.js';
+import { isHtmlElement } from './dom-helpers.js';
+import getParent from './get-parent.js';
+import { createsContainingBlock } from './containing-blocks.js';
 
 // https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_display/Containing_block#identifying_the_containing_block
 function isContainingBlock(element: Element, win: Window): boolean {
   const style = win.getComputedStyle(element);
-  const { transform, perspective } = style;
-  // TODO: https://github.com/pomerantsev/accented/issues/119
-  // Support other types of containing blocks
+  const { transform, perspective, contain, contentVisibility, containerType, filter, backdropFilter, willChange } = style;
+  const containItems = contain.split(' ');
+  const willChangeItems = willChange.split(/\s*,\s*/);
+
   return transform !== 'none'
-    || perspective !== 'none';
+    || perspective !== 'none'
+    || containItems.some((item) => ['layout', 'paint', 'strict', 'content'].includes(item))
+    || contentVisibility === 'auto'
+    || (createsContainingBlock('containerType') && containerType !== 'normal')
+    || (createsContainingBlock('filter') && filter !== 'none')
+    || (createsContainingBlock('backdropFilter') && backdropFilter !== 'none')
+    || willChangeItems.some((item) => ['transform', 'perspective', 'contain', 'filter', 'backdrop-filter'].includes(item));
 }
 
 function getNonInitialContainingBlock(element: Element, win: Window): Element | null {
   let currentElement: Element | null = element;
-  while (currentElement?.parentElement) {
-    currentElement = currentElement.parentElement;
-    if (isContainingBlock(currentElement, win)) {
+  while (currentElement) {
+    currentElement = getParent(currentElement);
+    if (currentElement && isContainingBlock(currentElement, win)) {
       return currentElement;
     }
   }
   return null;
 }
 
+/**
+ * https://github.com/pomerantsev/accented/issues/116
+ *
+ * This calculation leads to incorrectly positioned Accented triggers when all of the following are true:
+ * * The element is an SVG element.
+ * * The element itself, or one of the element's ancestors has a scale or rotate transform.
+ * * The browser doesn't support anchor positioning.
+ */
 export default function getElementPosition(element: Element, win: Window): Position {
   const nonInitialContainingBlock = getNonInitialContainingBlock(element, win);
-  // If an element has an ancestor whose transform is not 'none',
+  // If an element has a containing block as an ancestor,
+  // and that containing block is not the <html> element (the initial containing block),
   // fixed positioning works differently.
+  // https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_display/Containing_block#effects_of_the_containing_block
   // https://achrafkassioui.com/blog/position-fixed-and-CSS-transforms/
   if (nonInitialContainingBlock) {
     if (isHtmlElement(element)) {
@@ -42,8 +61,6 @@ export default function getElementPosition(element: Element, win: Window): Posit
       }
       return { top, left, width, height };
     } else {
-      // TODO: https://github.com/pomerantsev/accented/issues/116
-      // This is half-baked. It works incorrectly with scaled / rotated elements with issues.
       const elementRect = element.getBoundingClientRect();
       const nonInitialContainingBlockRect = nonInitialContainingBlock.getBoundingClientRect();
       return {

package/src/utils/get-parent.ts

@@ -0,0 +1,14 @@
+import { isDocumentFragment, isShadowRoot } from './dom-helpers.js';
+
+export default function getParent (element: Element): Element | null {
+  if (element.parentElement) {
+    return element.parentElement;
+  }
+
+  const rootNode = element.getRootNode();
+  if (isDocumentFragment(rootNode) && isShadowRoot(rootNode)) {
+    return rootNode.host;
+  }
+
+  return null;
+}