accented 0.0.0-20250124142030 → 0.0.0-20250223121749

package/src/elements/accented-dialog.ts

@@ -0,0 +1,384 @@
+import type { Issue } from '../types';
+import type { Signal } from '@preact/signals-core';
+import { effect } from '@preact/signals-core';
+import getElementHtml from '../utils/get-element-html.js';
+import { accentedUrl } from '../constants.js';
+import logAndRethrow from '../log-and-rethrow.js';
+
+export interface AccentedDialog extends HTMLElement {
+  issues: Signal<Array<Issue>> | undefined;
+  element: Element | undefined;
+  showModal: () => void;
+}
+
+// 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 () => {
+  const dialogTemplate = document.createElement('template');
+  dialogTemplate.innerHTML = `
+    <dialog dir="ltr" lang="en" aria-labelledby="title">
+      <div id="button-container">
+        <button id="close" aria-label="Close">✕</button>
+      </div>
+      <h2 id="title">Accessibility issues</h2>
+      <section id="element-html-container" aria-label="Element">
+        <code id="element-html"></code>
+      </section>
+      <ul id="issues"></ul>
+      <section id="footer">
+        <p>
+          Powered by
+          <a href="${accentedUrl}" target="_blank" aria-description="Opens in new tab">Accented</a>
+          and
+          <a href="https://github.com/dequelabs/axe-core" target="_blank" aria-description="Opens in new tab">axe-core</a>.
+        </p>
+      </section>
+    </dialog>
+  `;
+
+  const issueTemplate = document.createElement('template');
+  issueTemplate.innerHTML = `
+    <li>
+      <a target="_blank" aria-description="Opens in new tab"></a>
+      <div class="impact"></div>
+      <div class="description"></div>
+    </li>
+  `;
+
+  const descriptionTemplate = document.createElement('template');
+  descriptionTemplate.innerHTML = `
+    <span></span>
+    <ul></ul>
+  `;
+
+  const stylesheet = new CSSStyleSheet();
+  stylesheet.replaceSync(`
+    :host {
+      all: initial !important;
+
+      --light-color: white;
+      --dark-color: black;
+      --focus-color: #0078d4; /* Contrasts with both white and black. */
+
+      --impact-minor-color: lightgray;
+      --impact-moderate-color: gold;
+      --impact-serious-color: #ff9e00;
+      --impact-critical-color: #f883ec;
+
+      /* Spacing and typography custom props, inspired by https://utopia.fyi (simplified). */
+
+      /* @link https://utopia.fyi/type/calculator?c=320,16,1.2,1240,16,1.2,5,2,&s=0.75|0.5|0.25,1.5|2|3|4|6,s-l&g=s,l,xl,12 */
+      --ratio: 1.2;
+      --step-0: 1rem;
+      --step-1: calc(var(--step-0) * var(--ratio));
+      --step-2: calc(var(--step-1) * var(--ratio));
+      --step-3: calc(var(--step-2) * var(--ratio));
+      --step-4: calc(var(--step-3) * var(--ratio));
+      --step--1: calc(var(--step-0) / var(--ratio));
+
+      /* @link https://utopia.fyi/space/calculator?c=320,16,1.2,1240,16,1.2,5,2,&s=0.75|0.5|0.25,1.5|2|3|4|6,s-l&g=s,l,xl,12 */
+      --space-3xs: 0.25rem;
+      --space-2xs: 0.5rem;
+      --space-xs: 0.75rem;
+      --space-s: 1rem;
+      --space-m: 1.5rem;
+      --space-l: 2rem;
+      --space-xl: 3rem;
+      --space-2xl: 4rem;
+      --space-3xl: 6rem;
+    }
+
+    a[href], button {
+      outline-offset: 2px;
+      outline-color: var(--focus-color);
+      outline-width: 2px;
+      outline-style: none;
+
+      &:focus-visible {
+        outline-style: solid;
+      }
+
+      &:hover:not(:focus-visible) {
+        outline-style: dashed;
+      }
+    }
+
+    a[href] {
+      color: currentColor;
+    }
+
+    a[href][target="_blank"]::after {
+      content: " ↗";
+    }
+
+    dialog {
+      box-sizing: border-box;
+      overflow-wrap: break-word;
+      font-family: system-ui;
+      line-height: 1.5;
+      background-color: var(--light-color);
+      color: var(--dark-color);
+      border: 2px solid currentColor;
+      padding: var(--space-l);
+      inline-size: min(90ch, calc(100% - var(--space-s)* 2));
+      max-block-size: calc(100% - var(--space-s) * 2);
+    }
+
+    #button-container {
+      text-align: end;
+    }
+
+    #close {
+      background-color: var(--light-color);
+      color: var(--dark-color);
+      border: 2px solid currentColor;
+      padding-inline: var(--space-2xs);
+      aspect-ratio: 1 / 1;
+      font-size: var(--step-0);
+    }
+
+    h2 {
+      font-size: var(--step-4);
+      line-height: 1.2;
+      margin-block-start: var(--space-s);
+      margin-block-end: 0;
+    }
+
+    #element-html-container {
+      padding: var(--space-xs);
+      border: 2px solid currentColor;
+      margin-block-start: var(--space-l);
+    }
+
+    code {
+      /* https://systemfontstack.com/ */
+      font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace;
+      font-size: var(--step--1);
+    }
+
+    #issues {
+      font-size: var(--step-1);
+      margin-block-start: var(--space-l);
+      padding-inline: 0;
+      list-style: none;
+
+      & > li:not(:first-child) {
+        margin-block-start: var(--space-m);
+      }
+
+      a {
+        font-weight: bold;
+      }
+    }
+
+    .impact {
+      margin-block-start: var(--space-2xs);
+      font-size: var(--step--1);
+
+      inline-size: fit-content;
+      padding-inline: var(--space-3xs);
+
+      &[data-impact="minor"] {
+        background-color: var(--impact-minor-color);
+      }
+      &[data-impact="moderate"] {
+        background-color: var(--impact-moderate-color);
+      }
+      &[data-impact="serious"] {
+        background-color: var(--impact-serious-color);
+      }
+      &[data-impact="critical"] {
+        background-color: var(--impact-critical-color);
+      }
+    }
+
+    .description {
+      margin-block-start: var(--space-2xs);
+      font-size: var(--step--1);
+
+      li {
+        list-style-type: disc;
+      }
+    }
+
+    #footer {
+      margin-block-start: var(--space-l);
+      font-size: var(--step--1);
+
+      p {
+        margin: 0;
+        text-align: end;
+      }
+    }
+  `);
+
+  return class extends HTMLElement implements AccentedDialog {
+    #disposeOfEffect: (() => void) | undefined;
+
+    #abortController: AbortController | undefined;
+
+    issues: Signal<Array<Issue>> | undefined;
+
+    element: Element | undefined;
+
+    #elementMutationObserver: MutationObserver | undefined;
+
+    constructor() {
+      try {
+        super();
+        this.attachShadow({ mode: 'open' });
+        const content = dialogTemplate.content.cloneNode(true);
+        if (this.shadowRoot) {
+          this.shadowRoot.adoptedStyleSheets.push(stylesheet);
+          this.shadowRoot.append(content);
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    connectedCallback() {
+      try {
+        if (this.shadowRoot) {
+          const { shadowRoot } = this;
+          const dialog = shadowRoot.querySelector('dialog');
+          const closeButton = shadowRoot.querySelector('#close');
+          this.#abortController = new AbortController();
+          closeButton?.addEventListener('click', () => {
+            try {
+              dialog?.close();
+            } catch (error) {
+              logAndRethrow(error);
+            }
+          }, { signal: this.#abortController.signal });
+
+          dialog?.addEventListener('click', (event) => {
+            try {
+              this.#onDialogClick(event);
+            } catch (error) {
+              logAndRethrow(error);
+            }
+          }, { signal: this.#abortController.signal });
+
+          this.#disposeOfEffect = effect(() => {
+            if (this.issues) {
+              const issues = this.issues.value;
+              const issuesList = shadowRoot.getElementById('issues');
+              if (issuesList) {
+                issuesList.innerHTML = '';
+                for (const issue of issues) {
+                  const issueContent = issueTemplate.content.cloneNode(true) as Element;
+                  const title = issueContent.querySelector('a');
+                  const impact = issueContent.querySelector('.impact');
+                  const description = issueContent.querySelector('.description');
+                  if (title && impact && description) {
+                    title.textContent = issue.title + ' (' + issue.id + ')';
+                    title.href = issue.url;
+
+                    impact.textContent = 'User impact: ' + issue.impact;
+                    impact.setAttribute('data-impact', String(issue.impact));
+
+                    const descriptionItems = issue.description.split(/\n\s*/);
+                    const descriptionContent = descriptionTemplate.content.cloneNode(true) as Element;
+                    const descriptionTitle = descriptionContent.querySelector('span');
+                    const descriptionList = descriptionContent.querySelector('ul');
+                    if (descriptionTitle && descriptionList && descriptionItems.length > 1) {
+                      descriptionTitle.textContent = descriptionItems[0]!;
+                      for (const descriptionItem of descriptionItems.slice(1)) {
+                        const li = document.createElement('li');
+                        li.textContent = descriptionItem;
+                        descriptionList.appendChild(li);
+                      }
+                      description.appendChild(descriptionContent);
+                    }
+                  }
+                  issuesList.appendChild(issueContent);
+                }
+              }
+            }
+          });
+
+          const updateElementHtml = () => {
+            if (this.element) {
+              const elementHtmlContainer = shadowRoot.getElementById('element-html');
+              if (elementHtmlContainer) {
+                elementHtmlContainer.textContent = getElementHtml(this.element);
+              }
+            }
+          };
+
+          updateElementHtml();
+
+          this.#elementMutationObserver = new MutationObserver(() => {
+            try {
+              updateElementHtml();
+            } catch (error) {
+              logAndRethrow(error);
+            }
+          });
+          if (this.element) {
+            // We're only outputting the element itself, not its subtree.
+            // However, we're still listening for childList changes, because
+            // we display an ellipsis if the element has innerHTML,
+            // and we leave it empty if the element is empty.
+            this.#elementMutationObserver.observe(this.element, {
+              attributes: true,
+              childList: true
+            });
+          }
+
+          dialog?.addEventListener('close', () => {
+            try {
+              this.dispatchEvent(new Event('close'));
+            } catch (error) {
+              logAndRethrow(error);
+            }
+          }, { signal: this.#abortController.signal });
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    disconnectedCallback() {
+      try {
+        if (this.#disposeOfEffect) {
+          this.#disposeOfEffect();
+        }
+        if (this.#abortController) {
+          this.#abortController.abort();
+        }
+        if (this.#elementMutationObserver) {
+          this.#elementMutationObserver.disconnect();
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    showModal() {
+      if (this.shadowRoot) {
+        const dialog = this.shadowRoot.querySelector('dialog');
+        if (dialog) {
+          dialog.showModal();
+        }
+      }
+    }
+
+    #onDialogClick(event: MouseEvent) {
+      const dialog = event.currentTarget as HTMLDialogElement;
+      if (!dialog || typeof dialog.getBoundingClientRect !== 'function' || typeof dialog.close !== 'function') {
+        return;
+      }
+      const rect = dialog.getBoundingClientRect();
+      const isInsideDialog =
+        event.clientX >= rect.left &&
+        event.clientX <= rect.right &&
+        event.clientY >= rect.top &&
+        event.clientY <= rect.bottom;
+      if (!isInsideDialog) {
+        dialog.close();
+      }
+    }
+  };
+};

package/src/elements/accented-trigger.ts

@@ -0,0 +1,179 @@
+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';
+
+export interface AccentedTrigger extends HTMLElement {
+  element: Element | undefined;
+  dialog: AccentedDialog | undefined;
+  position: Signal<Position> | undefined;
+  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) => {
+  const template = document.createElement('template');
+
+  // I initially tried creating a CSSStyelSheet object with styles instead of having a <style> element in the template,
+  // but that led to a hard-to-catch layout bug in Safari in CI that caused a test to fail.
+  // It seems that when using adoptedStyleSheets, the styles may be applied asynchronously,
+  // which may have caused the layout bug.
+  // Using a <style> element does not seem to lead to any performance issues, so I'm keeping it this way.
+  template.innerHTML = `
+    <style>
+      :host {
+        position: fixed !important;
+        inset-inline-end: anchor(self-end) !important;
+        inset-block-start: anchor(self-start) !important;
+
+        position-visibility: anchors-visible !important;
+
+        /* Revert potential effects of white-space: pre; set on a trigger's ancestor. */
+        white-space: normal !important;
+      }
+
+      #trigger {
+        box-sizing: border-box;
+        font-size: 1rem;
+        inline-size: ${triggerSize};
+        block-size: ${triggerSize};
+
+        /* Make it look better in forced-colors mode. */
+        border: 2px solid transparent;
+
+        background-color: var(--${name}-primary-color);
+        color: var(--${name}-secondary-color);
+
+        outline-offset: -4px;
+        outline-color: currentColor;
+        outline-width: 2px;
+        outline-style: none;
+
+        &:focus-visible {
+          outline-style: solid;
+        }
+
+        &:hover:not(:focus-visible) {
+          outline-style: dashed;
+        }
+      }
+    </style>
+    <button id="trigger" lang="en">⚠</button>
+  `;
+
+  return class extends HTMLElement implements AccentedTrigger {
+    #abortController: AbortController | undefined;
+
+    #dialogCloseAbortController: AbortController | undefined;
+
+    #disposeOfPositionEffect: (() => void) | undefined;
+
+    #disposeOfVisibilityEffect: (() => void) | undefined;
+
+    element: Element | undefined;
+
+    dialog: AccentedDialog | undefined;
+
+    position: Signal<Position> | undefined;
+
+    visible: Signal<boolean> | undefined;
+
+    constructor() {
+      try {
+        super();
+        this.attachShadow({ mode: 'open' });
+        const content = template.content.cloneNode(true);
+        if (this.shadowRoot) {
+          this.shadowRoot.append(content);
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    connectedCallback() {
+      try {
+        if (this.shadowRoot) {
+          const { shadowRoot } = this;
+          const trigger = shadowRoot.getElementById('trigger');
+          if (trigger && this.element) {
+            trigger.ariaLabel = `Accessibility issues in ${this.element.nodeName.toLowerCase()}`;
+          }
+          this.#abortController = new AbortController();
+          trigger?.addEventListener('click', (event) => {
+            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 });
+              }
+            } 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.#disposeOfVisibilityEffect = effect(() => {
+              this.style.setProperty('visibility', this.visible?.value ? 'visible' : 'hidden', 'important');
+            });
+          }
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    disconnectedCallback() {
+      try {
+        if (this.#abortController) {
+          this.#abortController.abort();
+        }
+        if (this.#dialogCloseAbortController) {
+          this.#dialogCloseAbortController.abort();
+          this.dialog?.remove();
+        }
+        if (this.#disposeOfPositionEffect) {
+          this.#disposeOfPositionEffect();
+          this.#disposeOfPositionEffect = undefined;
+        }
+        if (this.#disposeOfVisibilityEffect) {
+          this.#disposeOfVisibilityEffect();
+          this.#disposeOfVisibilityEffect = undefined;
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+  };
+};

package/src/intersection-observer.ts

@@ -0,0 +1,28 @@
+import logAndRethrow from './log-and-rethrow.js';
+import { extendedElementsWithIssues } from './state.js';
+import getElementPosition from './utils/get-element-position.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);
+          }
+        }
+      }
+    } catch (error) {
+      logAndRethrow(error);
+    }
+  }, { threshold: 0 });
+
+  return {
+    intersectionObserver,
+    disconnect: () => {
+      intersectionObserver.disconnect();
+    }
+  };
+}

package/src/log-and-rethrow.ts

@@ -0,0 +1,9 @@
+import { issuesUrl } from './constants.js';
+
+export default 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}.`
+  );
+  throw error;
+}

package/src/logger.ts

@@ -1,20 +1,25 @@
 import { effect } from '@preact/signals-core';
-import { elementsWithIssues } from './state.js';
-
-const accentedUrl = 'https://www.npmjs.com/package/accented';
+import { elementsWithIssues, enabled } from './state.js';
+import { accentedUrl } from './constants.js';
 
 export default function createLogger() {
 
   let firstRun = true;
 
   return effect(() => {
-    if (elementsWithIssues.value.length > 0) {
-      console.log(`Elements with accessibility issues, identified by Accented (${accentedUrl}):\n`, elementsWithIssues.value);
+    if (!enabled.value) {
+      return;
+    }
+
+    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);
     } else {
       if (firstRun) {
         firstRun = false;
       } else {
-        console.log(`No elements with accessibility issues identified by Accented (${accentedUrl}).`);
+        console.log(`No accessibility issues found (Accented, ${accentedUrl}).`);
       }
     }
   });

package/src/register-elements.ts

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

package/src/resize-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('resize', () => {
+    try {
+      recalculatePositions();
+    } catch (error) {
+      logAndRethrow(error);
+    }
+  }, { signal: abortController.signal });
+
+  return () => {
+    abortController.abort();
+  };
+};