accented 0.0.1-dev.4 → 1.0.0

package/src/elements/accented-dialog.ts

@@ -0,0 +1,419 @@
+import type { Signal } from '@preact/signals-core';
+import { colorDark, colorLight, fontSystemMono, fontSystemSans } from '../common/tokens.js';
+import { accentedUrl } from '../constants.js';
+import { logAndRethrow } from '../log-and-rethrow.js';
+import type { Issue } from '../types.ts';
+import { getElementHtml } from '../utils/get-element-html.js';
+import { isNonEmpty } from '../utils/is-non-empty.js';
+
+export interface AccentedDialog extends HTMLElement {
+  issues: Signal<Array<Issue>> | undefined;
+  element: Element | undefined;
+  showModal: () => void;
+  open: boolean;
+}
+
+// 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 const getAccentedDialog = () => {
+  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;
+
+      /* OKLCH stuff: https://oklch.com/ */
+      --light-color: ${colorLight};
+      --dark-color: ${colorDark};
+
+      --background-color: light-dark(var(--light-color), var(--dark-color));
+      --text-color: light-dark(var(--dark-color), var(--light-color));
+
+      --impact-lightness: 0.80;
+      --focus-lightness: 0.45;
+      @media (prefers-color-scheme: dark) {
+        --impact-lightness: 0.45;
+        --focus-lightness: 0.80;
+      }
+
+      --blue-hue: 230;
+      --gold-hue: 90;
+      --red-hue: 0;
+
+      /* Contrasts with background. */
+      --focus-color: oklch(var(--focus-lightness) 0.25 var(--blue-hue));
+
+      --impact-chroma: 0.16;
+
+      --impact-moderate-hue: var(--blue-hue);
+      --impact-serious-hue: var(--gold-hue);
+      --impact-critical-hue: var(--red-hue);
+
+      --impact-minor-color: oklch(var(--impact-lightness) 0 0);
+      --impact-moderate-color: oklch(var(--impact-lightness) var(--impact-chroma) var(--impact-moderate-hue));
+      --impact-serious-color: oklch(var(--impact-lightness) var(--impact-chroma) var(--impact-serious-hue));
+      --impact-critical-color: oklch(var(--impact-lightness) var(--impact-chroma) var(--impact-critical-hue));
+
+      --base-size: max(1rem, 16px);
+
+      /* 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: var(--base-size);
+      --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: calc(0.25 * var(--base-size));
+      --space-2xs: calc(0.5 * var(--base-size));
+      --space-xs: calc(0.75 * var(--base-size));
+      --space-s: var(--base-size);
+      --space-m: calc(1.5 * var(--base-size));
+      --space-l: calc(2 * var(--base-size));
+      --space-xl: calc(3 * var(--base-size));
+      --space-2xl: calc(4 * var(--base-size));
+      --space-3xl: calc(6 * var(--base-size));
+    }
+
+    a[href], button {
+      outline-offset: 2px;
+      outline-color: var(--focus-color);
+      outline-width: 2px;
+      outline-style: none;
+
+      &:focus-visible {
+        outline-style: solid;
+      }
+
+      /* We should probably be comfortable with showing these styles on non-hover devices. */
+      &: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: ${fontSystemSans};
+      line-height: 1.5;
+      text-wrap: pretty;
+      background-color: var(--background-color);
+      color: var(--text-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);
+
+      color-scheme: light dark;
+    }
+
+    #button-container {
+      text-align: end;
+    }
+
+    #close {
+      background-color: var(--background-color);
+      color: var(--text-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 {
+      font-family: ${fontSystemMono};
+      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: 500;
+      }
+    }
+
+    .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 {
+    #abortController: AbortController | undefined;
+
+    issues: Signal<Array<Issue>> | undefined;
+
+    element: Element | undefined;
+
+    open = false;
+
+    constructor() {
+      super();
+      try {
+        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 },
+          );
+
+          dialog?.addEventListener(
+            'keydown',
+            (event) => {
+              try {
+                if (event.key === 'Escape') {
+                  event.stopPropagation();
+                }
+              } catch (error) {
+                logAndRethrow(error);
+              }
+            },
+            { signal: this.#abortController.signal },
+          );
+
+          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 &&
+                    isNonEmpty(descriptionItems) &&
+                    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);
+              }
+            }
+          }
+
+          if (this.element) {
+            const elementHtmlContainer = shadowRoot.getElementById('element-html');
+            if (elementHtmlContainer) {
+              elementHtmlContainer.textContent = getElementHtml(this.element);
+            }
+          }
+
+          dialog?.addEventListener(
+            'close',
+            () => {
+              try {
+                this.open = false;
+                this.dispatchEvent(new Event('close'));
+              } catch (error) {
+                logAndRethrow(error);
+              }
+            },
+            { signal: this.#abortController.signal },
+          );
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    disconnectedCallback() {
+      try {
+        if (this.#abortController) {
+          this.#abortController.abort();
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    showModal() {
+      if (this.shadowRoot) {
+        const dialog = this.shadowRoot.querySelector('dialog');
+        if (dialog) {
+          dialog.showModal();
+          this.open = true;
+        }
+      }
+    }
+
+    #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,251 @@
+import { effect } from '@preact/signals-core';
+import type { Signal } 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;
+  dialog: AccentedDialog | undefined;
+  position: Signal<Position> | undefined;
+  visible: Signal<boolean> | undefined;
+}
+
+// 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 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,
+  // 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 {
+        --ratio: 1.2;
+        --base-size: max(1rem, 16px);
+        position: fixed !important;
+        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-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;
+
+        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;
+        outline-style: none;
+
+        &:focus-visible {
+          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>
+  `;
+
+  return class extends HTMLElement implements AccentedTrigger {
+    #abortController: AbortController | undefined;
+
+    #dialogCloseAbortController: AbortController | undefined;
+
+    #disposeOfPositionEffect: (() => void) | undefined;
+
+    #disposeOfVisibilityEffect: (() => void) | undefined;
+
+    #elementMutationObserver: MutationObserver | undefined;
+
+    element: Element | undefined;
+
+    dialog: AccentedDialog | undefined;
+
+    position: Signal<Position> | undefined;
+
+    visible: Signal<boolean> | undefined;
+
+    constructor() {
+      super();
+      try {
+        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.#setTransform();
+
+          this.#elementMutationObserver = new MutationObserver(() => {
+            try {
+              this.#setTransform();
+            } catch (error) {
+              logAndRethrow(error);
+            }
+          });
+
+          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.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',
+            );
+          });
+        }
+      } catch (error) {
+        logAndRethrow(error);
+      }
+    }
+
+    disconnectedCallback() {
+      try {
+        if (this.#abortController) {
+          this.#abortController.abort();
+        }
+        if (this.#dialogCloseAbortController && !this.dialog?.open) {
+          this.#dialogCloseAbortController.abort();
+          this.dialog?.remove();
+        }
+        if (this.#disposeOfPositionEffect) {
+          this.#disposeOfPositionEffect();
+          this.#disposeOfPositionEffect = undefined;
+        }
+        if (this.#disposeOfVisibilityEffect) {
+          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();
+  };
+}