accented 0.0.2 → 1.0.1

package/src/elements/accented-trigger.ts

@@ -1,9 +1,10 @@
-import type { AccentedDialog } from './accented-dialog';
-import type { Position } from '../types';
-import { effect } from '@preact/signals-core';
 import type { Signal } from '@preact/signals-core';
-import supportsAnchorPositioning from '../utils/supports-anchor-positioning.js';
-import logAndRethrow from '../log-and-rethrow.js';
+import { effect } from '@preact/signals-core';
+import { fontSystemSans } from '../common/tokens.js';
+import { logAndRethrow } from '../log-and-rethrow.js';
+import type { Position } from '../types.ts';
+import { supportsAnchorPositioning } from '../utils/supports-anchor-positioning.js';
+import type { AccentedDialog } from './accented-dialog.ts';
 
 export interface AccentedTrigger extends HTMLElement {
   element: Element | undefined;
@@ -12,11 +13,9 @@ export interface AccentedTrigger extends HTMLElement {
   visible: Signal<boolean> | undefined;
 }
 
-const triggerSize = 'max(32px, 2rem)';
-
 // We want Accented to not throw an error in Node, and use static imports,
 // so we can't export `class extends HTMLElement` because HTMLElement is not available in Node.
-export default (name: string) => {
+export const getAccentedTrigger = (name: string) => {
   const template = document.createElement('template');
 
   // I initially tried creating a CSSStyelSheet object with styles instead of having a <style> element in the template,
@@ -27,21 +26,44 @@ export default (name: string) => {
   template.innerHTML = `
     <style>
       :host {
+        --ratio: 1.2;
+        --base-size: max(1rem, 16px);
         position: fixed !important;
-        inset-inline-end: anchor(self-end) !important;
-        inset-block-start: anchor(self-start) !important;
-
-        position-visibility: anchors-visible !important;
+        ${
+          supportsAnchorPositioning(window)
+            ? `
+          inset-inline-start: anchor(self-start) !important;
+          inset-inline-end: anchor(self-end) !important;
+          inset-block-start: anchor(self-start) !important;
+          inset-block-end: anchor(self-end) !important;
+        `
+            : ''
+        }
 
         /* Revert potential effects of white-space: pre; set on a trigger's ancestor. */
         white-space: normal !important;
+
+        pointer-events: none !important;
       }
 
       #trigger {
+        pointer-events: auto;
+
+        user-select: none;
+
+        margin-inline-start: auto;
+        margin-inline-end: 4px;
+        margin-block-start: 4px;
+
         box-sizing: border-box;
-        font-size: 1rem;
-        inline-size: ${triggerSize};
-        block-size: ${triggerSize};
+        font-family: ${fontSystemSans};
+        font-size: calc(var(--ratio) * var(--ratio) * var(--base-size));
+        inline-size: calc(2 * var(--base-size));
+        block-size: calc(2 * var(--base-size));
+
+        display: flex;
+        align-items: center;
+        justify-content: center;
 
         /* Make it look better in forced-colors mode. */
         border: 2px solid transparent;
@@ -49,6 +71,10 @@ export default (name: string) => {
         background-color: var(--${name}-primary-color);
         color: var(--${name}-secondary-color);
 
+        padding: 0;
+
+        border-radius: calc(0.25 * var(--base-size));
+
         outline-offset: -4px;
         outline-color: currentColor;
         outline-width: 2px;
@@ -58,12 +84,13 @@ export default (name: string) => {
           outline-style: solid;
         }
 
+        /* We should probably be comfortable with showing these styles on non-hover devices. */
         &:hover:not(:focus-visible) {
           outline-style: dashed;
         }
       }
     </style>
-    <button id="trigger" lang="en">⚠</button>
+    <button id="trigger" lang="en">á</button>
   `;
 
   return class extends HTMLElement implements AccentedTrigger {
@@ -75,6 +102,8 @@ export default (name: string) => {
 
     #disposeOfVisibilityEffect: (() => void) | undefined;
 
+    #elementMutationObserver: MutationObserver | undefined;
+
     element: Element | undefined;
 
     dialog: AccentedDialog | undefined;
@@ -84,8 +113,8 @@ export default (name: string) => {
     visible: Signal<boolean> | undefined;
 
     constructor() {
+      super();
       try {
-        super();
         this.attachShadow({ mode: 'open' });
         const content = template.content.cloneNode(true);
         if (this.shadowRoot) {
@@ -104,50 +133,82 @@ export default (name: string) => {
           if (trigger && this.element) {
             trigger.ariaLabel = `Accessibility issues in ${this.element.nodeName.toLowerCase()}`;
           }
-          this.#abortController = new AbortController();
-          trigger?.addEventListener('click', (event) => {
+
+          this.#setTransform();
+
+          this.#elementMutationObserver = new MutationObserver(() => {
             try {
-              event.preventDefault();
-
-              // We append the dialog when the button is clicked,
-              // and remove it from the DOM when the dialog is closed.
-              // This gives us a performance improvement since Axe
-              // scan time seems to depend on the number of elements in the DOM.
-              if (this.dialog) {
-                this.#dialogCloseAbortController = new AbortController();
-                document.body.append(this.dialog);
-                this.dialog.showModal();
-                this.dialog.addEventListener('close', () => {
-                  try {
-                    this.dialog?.remove();
-                    this.#dialogCloseAbortController?.abort();
-                  } catch (error) {
-                    logAndRethrow(error);
-                  }
-                }, { signal: this.#dialogCloseAbortController.signal });
-              }
+              this.#setTransform();
             } catch (error) {
               logAndRethrow(error);
             }
-          }, { signal: this.#abortController.signal });
+          });
+
+          if (this.element) {
+            this.#elementMutationObserver.observe(this.element, {
+              attributes: true,
+            });
+          }
+
+          this.#abortController = new AbortController();
+          trigger?.addEventListener(
+            'click',
+            (event) => {
+              try {
+                // event.preventDefault() ensures that if the issue is within a link,
+                // the link's default behavior (following the URL) is prevented.
+                event.preventDefault();
+
+                // event.stopPropagation() ensures that if there's a click handler on the trigger's ancestor
+                // (a link, or a button, or anything else), it doesn't get triggered.
+                event.stopPropagation();
+
+                // We append the dialog when the button is clicked,
+                // and remove it from the DOM when the dialog is closed.
+                // This gives us a performance improvement since Axe
+                // scan time seems to depend on the number of elements in the DOM.
+                if (this.dialog) {
+                  this.#dialogCloseAbortController = new AbortController();
+                  document.body.append(this.dialog);
+                  this.dialog.showModal();
+                  this.dialog.addEventListener(
+                    'close',
+                    () => {
+                      try {
+                        this.dialog?.remove();
+                        this.#dialogCloseAbortController?.abort();
+                      } catch (error) {
+                        logAndRethrow(error);
+                      }
+                    },
+                    { signal: this.#dialogCloseAbortController.signal },
+                  );
+                }
+              } catch (error) {
+                logAndRethrow(error);
+              }
+            },
+            { signal: this.#abortController.signal },
+          );
 
           if (!supportsAnchorPositioning(window)) {
             this.#disposeOfPositionEffect = effect(() => {
               if (this.position && trigger) {
                 const position = this.position.value;
-                this.style.setProperty('top', `${position.blockStartTop}px`, 'important');
-                if (position.direction === 'ltr') {
-                  this.style.setProperty('left', `calc(${position.inlineEndLeft}px - ${triggerSize})`, 'important');
-                } else if (this.position.value.direction === 'rtl') {
-                  this.style.setProperty('left', `${position.inlineEndLeft}px`, 'important');
-                }
+                this.style.setProperty('top', `${position.top}px`, 'important');
+                this.style.setProperty('left', `${position.left}px`, 'important');
+                this.style.setProperty('width', `${position.width}px`, 'important');
+                this.style.setProperty('height', `${position.height}px`, 'important');
               }
             });
-
-            this.#disposeOfVisibilityEffect = effect(() => {
-              this.style.setProperty('visibility', this.visible?.value ? 'visible' : 'hidden', 'important');
-            });
           }
+          this.#disposeOfVisibilityEffect = effect(() => {
+            this.style.setProperty(
+              'visibility',
+              this.visible?.value ? 'visible' : 'hidden',
+              'important',
+            );
+          });
         }
       } catch (error) {
         logAndRethrow(error);
@@ -159,7 +220,7 @@ export default (name: string) => {
         if (this.#abortController) {
           this.#abortController.abort();
         }
-        if (this.#dialogCloseAbortController) {
+        if (this.#dialogCloseAbortController && !this.dialog?.open) {
           this.#dialogCloseAbortController.abort();
           this.dialog?.remove();
         }
@@ -171,9 +232,26 @@ export default (name: string) => {
           this.#disposeOfVisibilityEffect();
           this.#disposeOfVisibilityEffect = undefined;
         }
+        if (this.#elementMutationObserver) {
+          this.#elementMutationObserver.disconnect();
+        }
       } catch (error) {
         logAndRethrow(error);
       }
     }
+
+    #setTransform() {
+      // We read and write values in separate animation frames to avoid layout thrashing.
+      window.requestAnimationFrame(() => {
+        if (this.element) {
+          const transform = window.getComputedStyle(this.element).getPropertyValue('transform');
+          if (transform !== 'none') {
+            window.requestAnimationFrame(() => {
+              this.style.setProperty('transform', transform, 'important');
+            });
+          }
+        }
+      });
+    }
   };
 };

package/src/fullscreen-listener.ts

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

package/src/intersection-observer.ts

@@ -1,28 +1,39 @@
-import logAndRethrow from './log-and-rethrow.js';
+import { logAndRethrow } from './log-and-rethrow.js';
 import { extendedElementsWithIssues } from './state.js';
-import getElementPosition from './utils/get-element-position.js';
+import { getElementPosition } from './utils/get-element-position.js';
+import { supportsAnchorPositioning } from './utils/supports-anchor-positioning.js';
 
-export default function setupIntersectionObserver() {
-  const intersectionObserver = new IntersectionObserver((entries) => {
-    try {
-      for (const entry of entries) {
-        const extendedElementWithIssues = extendedElementsWithIssues.value.find(el => el.element === entry.target);
-        if (extendedElementWithIssues) {
-          extendedElementWithIssues.visible.value = entry.isIntersecting;
-          if (entry.isIntersecting) {
-            extendedElementWithIssues.position.value = getElementPosition(entry.target, window);
+export function setupIntersectionObserver() {
+  const intersectionObserver = new IntersectionObserver(
+    (entries) => {
+      try {
+        for (const entry of entries) {
+          const extendedElementWithIssues = extendedElementsWithIssues.value.find(
+            (el) => el.element === entry.target,
+          );
+          if (extendedElementWithIssues) {
+            // We initially treated setting visibility in the intersection observer
+            // as a fallback option for browsers that don't support `position-visibility`,
+            // but then we realized that this `position-visibility` actually works
+            // in an unexpected way when the container has `overflow: visible`.
+            // So now we always set visibility in the intersection observer.
+            extendedElementWithIssues.visible.value = entry.isIntersecting;
+            if (entry.isIntersecting && !supportsAnchorPositioning(window)) {
+              extendedElementWithIssues.position.value = getElementPosition(entry.target, window);
+            }
           }
         }
+      } catch (error) {
+        logAndRethrow(error);
       }
-    } catch (error) {
-      logAndRethrow(error);
-    }
-  }, { threshold: 0 });
+    },
+    { threshold: 0 },
+  );
 
   return {
     intersectionObserver,
     disconnect: () => {
       intersectionObserver.disconnect();
-    }
+    },
   };
 }

package/src/log-and-rethrow.ts

@@ -1,9 +1,8 @@
 import { issuesUrl } from './constants.js';
 
-export default function logAndRethrow(error: unknown) {
+export function logAndRethrow(error: unknown) {
   console.error(
-    `Accented threw an error (see below). Try updating your browser to the latest version. ` +
-      `If you’re still seeing the error, file an issue at ${issuesUrl}.`
+    `Accented threw an error (see below). Try updating your browser to the latest version. If you’re still seeing the error, file an issue at ${issuesUrl}.`,
   );
   throw error;
 }

package/src/logger.ts

@@ -1,9 +1,13 @@
 import { effect } from '@preact/signals-core';
-import { elementsWithIssues, enabled } from './state.js';
 import { accentedUrl } from './constants.js';
+import { elementsWithIssues, enabled } from './state.js';
+import type { ElementWithIssues } from './types.ts';
 
-export default function createLogger() {
+function filterPropsForOutput(elements: Array<ElementWithIssues>) {
+  return elements.map(({ element, issues }) => ({ element, issues }));
+}
 
+export function createLogger() {
   let firstRun = true;
 
   return effect(() => {
@@ -13,8 +17,14 @@ 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);
+      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`,
+        filterPropsForOutput(elementsWithIssues.value),
+      );
     } else {
       if (firstRun) {
         firstRun = false;

package/src/register-elements.ts

@@ -1,16 +1,16 @@
-import getAccentedTrigger from './elements/accented-trigger.js';
-import getAccentedDialog from './elements/accented-dialog.js';
+import { getAccentedDialog } from './elements/accented-dialog.js';
+import { getAccentedTrigger } from './elements/accented-trigger.js';
 
-export default function registerElements(name: string): void {
+export function registerElements(name: string): void {
   const elements = [
     {
       elementName: `${name}-trigger`,
-      Component: getAccentedTrigger(name)
+      Component: getAccentedTrigger(name),
     },
     {
       elementName: `${name}-dialog`,
-      Component: getAccentedDialog()
-    }
+      Component: getAccentedDialog(),
+    },
   ];
 
   for (const { elementName, Component } of elements) {
@@ -18,4 +18,4 @@ export default function registerElements(name: string): void {
       customElements.define(elementName, Component);
     }
   }
-};
+}

package/src/resize-listener.ts

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