@astryxdesign/core 0.7.8 → 0.7.9-canary.0200dfe

package/src/utils/coarsePointer.ts

@@ -3,11 +3,12 @@
 /**
  * @file coarsePointer.ts
  * @input A window
- * @output Exports isCoarsePointer and watchCoarsePointer: whether the
- *   primary pointer is coarse (TOUCH_QUERY), and when it changes
+ * @output Exports isCoarsePointer, watchCoarsePointer and watchMediaQuery:
+ *   whether the primary pointer is coarse (TOUCH_QUERY), and when it or any
+ *   media query changes
  * @position The coarse-pointer gate of packages/core/src/gestures and of
  *   the press controller (pressFeedback.ts): touch-only work registers only
- *   while it holds
+ *   while it holds. useMediaQuery watches through watchMediaQuery
  *
  * Under a coarse primary pointer, a phone's touch work stays registered: the
  * gesture host's page listeners, the page hold and the finger scroll. Under a
@@ -29,23 +30,35 @@ export function isCoarsePointer(view: Window | null | undefined): boolean {
 }
 
 /**
- * Call `listener` with the new answer each time the primary pointer of
- * `view` turns coarse or fine, until the returned function is called.
+ * Call `listener` with the new answer each time `query` starts or stops
+ * matching in `view`, until the returned function is called.
  */
-export function watchCoarsePointer(
+export function watchMediaQuery(
   view: Window | null | undefined,
-  listener: (isCoarse: boolean) => void,
+  query: string,
+  listener: (matches: boolean) => void,
 ): () => void {
   if (typeof view?.matchMedia !== 'function') {
     return () => {};
   }
-  const query = view.matchMedia(TOUCH_QUERY);
-  const onChange = (): void => listener(query.matches);
-  if (typeof query.addEventListener === 'function') {
-    query.addEventListener('change', onChange);
-    return () => query.removeEventListener('change', onChange);
+  const list = view.matchMedia(query);
+  const onChange = (): void => listener(list.matches);
+  if (typeof list.addEventListener === 'function') {
+    list.addEventListener('change', onChange);
+    return () => list.removeEventListener('change', onChange);
   }
   // Safari before 14 only has the older pair.
-  query.addListener(onChange);
-  return () => query.removeListener(onChange);
+  list.addListener(onChange);
+  return () => list.removeListener(onChange);
+}
+
+/**
+ * Call `listener` with the new answer each time the primary pointer of
+ * `view` turns coarse or fine, until the returned function is called.
+ */
+export function watchCoarsePointer(
+  view: Window | null | undefined,
+  listener: (isCoarse: boolean) => void,
+): () => void {
+  return watchMediaQuery(view, TOUCH_QUERY, listener);
 }

package/src/utils/flatTree.ts

@@ -3,11 +3,12 @@
 /**
  * @file flatTree.ts
  * @input A DOM node
- * @output Exports parentAcrossShadow, and containsAlongFlatTree, which walks it
+ * @output Exports parentAcrossShadow, containsAlongFlatTree, which walks it,
+ *   and deepActiveElement
  * @position The flat-tree parent the browser scrolls and dispatches
- *   through, shared by the gesture host's native-scroll probe and the
+ *   through, shared by the gesture host's native-scroll probe, the
  *   selection lock (which the press feedback controller uses without the
- *   gesture system)
+ *   gesture system) and the Layer module's input hold
  */
 
 /** The node's parent, crossing out of shadow roots. */
@@ -38,3 +39,14 @@ export function containsAlongFlatTree(ancestor: Node, node: Node): boolean {
   }
   return false;
 }
+
+/** The focused element of `doc`, inside open shadow roots too. */
+export function deepActiveElement(
+  doc: Document | null | undefined,
+): Element | null {
+  let active = doc?.activeElement ?? null;
+  while (active?.shadowRoot?.activeElement != null) {
+    active = active.shadowRoot.activeElement;
+  }
+  return active;
+}

package/src/utils/focusReturn.ts

@@ -5,8 +5,9 @@
  * @input The document's current active element and the shared interaction
  *   modality.
  * @output Whether focus would be lost if a surface hid now; a focus move whose
- *   ring follows the last input; and the one path that moves focus out of
- *   content a change removed or hid (`noteFocusWithin`, `moveFocusLeftBehind`).
+ *   ring follows the last input; the focus return of a closed overlay, which
+ *   never scrolls the page; and the one path that moves focus out of content a
+ *   change removed or hid (`noteFocusWithin`, `moveFocusLeftBehind`).
  * @position Utility; used by overlays (BottomSheet, Dialog, DropdownMenu) that
  *   move focus programmatically, and by disclosures that hide focused
  *   content. isFocusDetached lives in isFocusDetached.ts, so the utils entry,
@@ -130,30 +131,89 @@ export function focusForLastInput(
 }
 
 /**
- * Prepares the focus return for an open surface that may be removed while
- * open (rendered only while open, or removed with its view). Removing a
- * `<dialog>` runs no close and no browser focus return. Call this while the
- * surface is mounted: it reads the frame that hosts the surface now, because a
- * removed frame's document has no window. Call the returned function from the
- * effect cleanup with the opener.
+ * Returns focus to `opener` after an overlay closes, without a scroll and with
+ * the ring the last input calls for. WebKit records the nearest focusable
+ * ancestor of a tapped button as the opener, such as a `tabindex="-1"` main
+ * region. A reveal of that region scrolls the page to its top edge.
+ */
+export function returnFocusForLastInput(
+  opener: HTMLElement,
+  modality?: InteractionModality,
+): void {
+  focusForLastInput(opener, {preventScroll: true}, modality);
+}
+
+/**
+ * Prepares a focus repair for an open surface that may be removed while open
+ * (rendered only while open, or removed with its view). Removing a `<dialog>`
+ * runs no close and no browser focus return. Call this while the surface is
+ * mounted: it reads the frame that hosts the surface now, because a removed
+ * frame's document has no window. Call the returned function from the effect
+ * cleanup with the repair to run.
  *
- * Once the commit has finished, focus moves to the opener only when the
- * surface really left the document (StrictMode's simulated unmount keeps it),
- * the opener is still on the page, and the removal lost focus, both in the
- * surface's document and in the document that hosts its frame. A control the
- * user pressed outside the surface, or outside its frame, keeps its focus.
+ * Once the commit has finished, the repair runs only when the surface really
+ * left the document (StrictMode's simulated unmount keeps it) and the removal
+ * lost focus, both in the surface's document and in the document that hosts
+ * its frame. A control the user pressed outside the surface, or outside its
+ * frame, keeps its focus, and so does a surface that took focus in the same
+ * commit.
  */
-export function prepareFocusReturnOnRemoval(
+export function prepareFocusRepairOnRemoval(
   surface: Element,
-): (opener: Element | null) => void {
+  options?: {
+    /**
+     * Skip the repair when focus already rested on the page body before the
+     * commit's first removal: the removal did not lose that focus.
+     */
+    keepRestingFocus?: boolean;
+  },
+): (repair: () => void) => void {
   const host = surface.ownerDocument.defaultView?.frameElement ?? null;
-  return opener => {
+  return repair => {
+    if (
+      options?.keepRestingFocus === true &&
+      wasFocusDetachedBeforeRemoval(surface.ownerDocument)
+    ) {
+      return;
+    }
     queueMicrotask(() => {
-      if (surface.isConnected || opener == null || !opener.isConnected) {
+      if (surface.isConnected) {
         return;
       }
       if (isFocusLost(surface) && (host == null || isFocusLost(host))) {
-        focusForLastInput(opener as HTMLElement);
+        repair();
+      }
+    });
+  };
+}
+
+// Whether focus rested on the page body when the current commit began
+// removing surfaces, per document. One removal can drop focus before a later
+// surface's cleanup runs, so every cleanup of the commit reads the first value.
+const focusDetachedAtRemovalStart = new WeakMap<Document, boolean>();
+function wasFocusDetachedBeforeRemoval(doc: Document): boolean {
+  let wasDetached = focusDetachedAtRemovalStart.get(doc);
+  if (wasDetached === undefined) {
+    wasDetached = isFocusDetached(doc);
+    focusDetachedAtRemovalStart.set(doc, wasDetached);
+    queueMicrotask(() => focusDetachedAtRemovalStart.delete(doc));
+  }
+  return wasDetached;
+}
+
+/**
+ * The focus repair above that returns focus to `opener` while the opener is
+ * still on the page. Call the returned function from the effect cleanup with
+ * the opener.
+ */
+export function prepareFocusReturnOnRemoval(
+  surface: Element,
+): (opener: Element | null) => void {
+  const repairOnRemoval = prepareFocusRepairOnRemoval(surface);
+  return opener => {
+    repairOnRemoval(() => {
+      if (opener != null && opener.isConnected) {
+        returnFocusForLastInput(opener as HTMLElement);
       }
     });
   };

package/src/utils/hitArea.ts

@@ -24,6 +24,9 @@
 // live control measures: only under a coarse primary pointer (AST-094), only on
 // screen, and in one read pass per frame within a 4 ms budget. Until the first
 // pass the insets are 0, so first paint never overlaps anything.
+// The insets are lengths in the control's own box, so a pass measures in its
+// layout px. A layer that opens from a smaller scale then keeps the insets of
+// the size it settles at.
 
 import {observeContent} from './sharedMutationObserver';
 
@@ -264,6 +267,7 @@ function now(): number {
 interface Watch {
   readonly element: Element;
   readonly minSize: number;
+  readonly ownsDescendantTouches: boolean;
   readonly onInsets: (insets: HitInsets) => void;
   isVisible: boolean;
   last: HitInsets;
@@ -284,6 +288,8 @@ const observedSizes = new WeakMap<Element, string>();
 const scopeTimers = new Map<Element, ReturnType<typeof setTimeout>>();
 let frame: number | null = null;
 let view: Window | null = null;
+/** The document the shared press listener is on, while it is on one. */
+let pressDocument: Document | null = null;
 let pointer: MediaQueryList | null = null;
 let visibility: IntersectionObserver | null = null;
 let resize: ResizeObserver | null = null;
@@ -330,6 +336,95 @@ function plainRect(element: Element): HitRect {
   return {left, top, right, bottom};
 }
 
+/** A box that the transforms around it leave at its layout size. */
+const UNSCALED = {x: 1, y: 1} as const;
+
+/** One axis of a box's scale on screen: its client size over its layout size. */
+function axisScale(onScreen: number, layout: number): number {
+  if (!(layout > 0) || !(onScreen > 0)) {
+    return 1;
+  }
+  const scale = onScreen / layout;
+  // Within rounding of 1 the box is at its layout size: no change to the rects.
+  return Math.abs(scale - 1) < 1e-3 ? 1 : scale;
+}
+
+/**
+ * How far the transforms around `element` scale its box on screen, per axis.
+ * A layer that opens from a smaller scale scales every rect inside it, while
+ * the layout box keeps the size the layer settles at. Only a scale is
+ * expected: a rotated or skewed box would read as a larger scale.
+ */
+function screenScale(
+  element: Element,
+  onScreen: HitRect,
+): {x: number; y: number} {
+  // The offset size is the layout size in whole pixels, unaffected by
+  // transforms, and costs no style resolution. A box with none, such as an SVG
+  // element or a jsdom box, reads as unscaled.
+  const box = element as Partial<HTMLElement>;
+  const offsetWidth = box.offsetWidth ?? 0;
+  const offsetHeight = box.offsetHeight ?? 0;
+  if (offsetWidth === 0 || offsetHeight === 0) {
+    return UNSCALED;
+  }
+  // Within a pixel of its layout size the box reads as unscaled, which bounds
+  // the inset error at about a pixel. Only a box that a transform shrinks or
+  // grows reads its exact size from the computed style.
+  if (
+    Math.abs(onScreen.right - onScreen.left - offsetWidth) <= 1 &&
+    Math.abs(onScreen.bottom - onScreen.top - offsetHeight) <= 1
+  ) {
+    return UNSCALED;
+  }
+  const style = element.ownerDocument.defaultView?.getComputedStyle(element);
+  if (style == null || !style.width.endsWith('px')) {
+    return UNSCALED;
+  }
+  const px = (value: string) => Number.parseFloat(value) || 0;
+  const isContentBox = style.boxSizing !== 'border-box';
+  const width =
+    px(style.width) +
+    (isContentBox
+      ? px(style.paddingLeft) +
+        px(style.paddingRight) +
+        px(style.borderLeftWidth) +
+        px(style.borderRightWidth)
+      : 0);
+  const height =
+    px(style.height) +
+    (isContentBox
+      ? px(style.paddingTop) +
+        px(style.paddingBottom) +
+        px(style.borderTopWidth) +
+        px(style.borderBottomWidth)
+      : 0);
+  return {
+    x: axisScale(onScreen.right - onScreen.left, width),
+    y: axisScale(onScreen.bottom - onScreen.top, height),
+  };
+}
+
+/**
+ * `rect` in the layout px of the box at `origin`: its offset from `origin`,
+ * divided by that box's scale on screen.
+ */
+function inLayout(
+  rect: HitRect,
+  origin: HitRect,
+  scale: {x: number; y: number},
+): HitRect {
+  if (scale.x === 1 && scale.y === 1) {
+    return rect;
+  }
+  return {
+    left: origin.left + (rect.left - origin.left) / scale.x,
+    top: origin.top + (rect.top - origin.top) / scale.y,
+    right: origin.left + (rect.right - origin.left) / scale.x,
+    bottom: origin.top + (rect.bottom - origin.top) / scale.y,
+  };
+}
+
 interface Candidate {
   readonly element: Element;
   readonly rect: HitRect;
@@ -373,14 +468,15 @@ function measureOne(
   candidates: ReadonlyArray<Candidate>,
 ): {target: HitRect; insets: HitInsets; neighbours: HitRect[]} {
   const target = plainRect(watch.element);
+  const scale = screenScale(watch.element, target);
   // Two targets each growing up to half the minimum reach each other from a
   // minimum apart.
   const reach = Math.max(0, watch.minSize);
   const band = grown(target, {
-    top: reach,
-    right: reach,
-    bottom: reach,
-    left: reach,
+    top: reach * scale.y,
+    right: reach * scale.x,
+    bottom: reach * scale.y,
+    left: reach * scale.x,
   });
   const neighbours = candidates
     .filter(
@@ -393,7 +489,16 @@ function measureOne(
     .map(({rect}) => rect);
   return {
     target,
-    insets: clampedHitInsets(target, neighbours, watch.minSize),
+    // The insets are in the control's layout px. The returned rects stay in
+    // screen px for a touch's distance checks. A neighbour maps by the
+    // control's scale, as if it is in the same layer. A neighbour outside that
+    // layer then reads farther away. A touch compares screen distances, so it
+    // still counts that neighbour.
+    insets: clampedHitInsets(
+      inLayout(target, target, scale),
+      neighbours.map(rect => inLayout(rect, target, scale)),
+      watch.minSize,
+    ),
     neighbours,
   };
 }
@@ -497,7 +602,16 @@ function checkPress(element: Element, event: PointerEvent): void {
     const own = distanceTo(target, x, y);
     isNearerNeighbour ||= neighbours.some(rect => distanceTo(rect, x, y) < own);
   }
-  if (isNearerNeighbour) {
+  // A watch can own its descendants' touches. Then a press that the browser
+  // hit-tests onto a descendant lands on content the element paints, even
+  // past its own box. A swipe panel's entry beside a moved row is such
+  // content. That touch is the element's.
+  const isOnOwnContent =
+    [...entry.watches].some(watch => watch.ownsDescendantTouches) &&
+    press.target instanceof Node &&
+    press.target !== element &&
+    element.contains(press.target);
+  if (isNearerNeighbour && !isOnOwnContent) {
     const swallow = (click: Event) => {
       disarm();
       // A keyboard or assistive-technology activation (detail 0) is never
@@ -585,7 +699,8 @@ function startObserving(): void {
     return;
   }
   view.addEventListener('resize', scheduleAll);
-  view.document.addEventListener('pointerdown', onPress, PASSIVE_CAPTURE);
+  pressDocument = view.document;
+  pressDocument.addEventListener('pointerdown', onPress, PASSIVE_CAPTURE);
   if (typeof IntersectionObserver === 'function') {
     visibility = new IntersectionObserver(entries => {
       for (const entry of entries) {
@@ -641,7 +756,10 @@ function stopObserving(): void {
     entry.release = null;
   }
   view?.removeEventListener('resize', scheduleAll);
-  view?.document.removeEventListener('pointerdown', onPress, PASSIVE_CAPTURE);
+  // The listener leaves the document it went on. A window can close first, as
+  // a removed iframe's, and then it has no document to read.
+  pressDocument?.removeEventListener('pointerdown', onPress, PASSIVE_CAPTURE);
+  pressDocument = null;
   visibility?.disconnect();
   resize?.disconnect();
   visibility = null;
@@ -675,6 +793,13 @@ function onPointerChange(): void {
 export interface WatchHitAreaOptions {
   /** The size to grow toward, px. @default 44 */
   readonly minSize?: number;
+  /**
+   * A touch that the browser hit-tests onto a descendant is the element's,
+   * however near a neighbour is. Set it for a host whose content can paint
+   * past its box, such as a list row with a swipe panel. A control whose
+   * grown input is its descendant leaves it off. @default false
+   */
+  readonly ownsDescendantTouches?: boolean;
 }
 
 /**
@@ -706,7 +831,10 @@ export function resetHitAreaForTests(): void {
 export function watchHitArea(
   element: Element,
   onInsets: (insets: HitInsets) => void,
-  {minSize = MIN_TOUCH_TARGET}: WatchHitAreaOptions = {},
+  {
+    minSize = MIN_TOUCH_TARGET,
+    ownsDescendantTouches = false,
+  }: WatchHitAreaOptions = {},
 ): () => void {
   const owner = element.ownerDocument.defaultView;
   if (owner == null) {
@@ -726,6 +854,7 @@ export function watchHitArea(
   const watch: Watch = {
     element,
     minSize,
+    ownsDescendantTouches,
     onInsets,
     isVisible: isCoarse && visibility == null,
     last: NO_HIT_INSETS,

package/src/utils/inputPresentation.ts

@@ -2,7 +2,8 @@
 
 /**
  * @file inputPresentation.ts
- * @input A presentation policy, the deprecated nativePicker value, and pointer type
+ * @input A presentation policy, the deprecated nativePicker value, whether the
+ *   native date control can show the calendar, and pointer type
  * @output The resolved picker surface for DateInput, DateTimeInput, and TimeInput
  * @position Shared presentation vocabulary (AST-043)
  *
@@ -113,6 +114,25 @@ export function effectiveInputPresentation(
   return DEFAULT_INPUT_PRESENTATION;
 }
 
+/**
+ * The policy a date picker follows in its calendar. `<input type="date">` is
+ * Gregorian, so in a calendar it cannot show, the policies that use it
+ * (`native` and `adaptive-native`) use the Astryx popover on a fine pointer and
+ * the bottom sheet on a coarse one instead.
+ */
+export function calendarPickerPresentation(
+  presentation: PickerPresentation,
+  isNativeCalendar: boolean,
+): PickerPresentation {
+  if (
+    !isNativeCalendar &&
+    (presentation === 'native' || presentation === 'adaptive-native')
+  ) {
+    return 'adaptive-bottom-sheet';
+  }
+  return presentation;
+}
+
 /** Resolve a picker-only policy to the surface rendered for the current pointer. */
 export function resolvePickerPresentation(
   presentation: PickerPresentation,

package/src/utils/inputStream.ts

@@ -4,7 +4,8 @@
  * @file inputStream.ts
  * @input A window, and subscribers to its input events (the press feedback
  *   controller, the gesture host)
- * @output subscribeInput
+ * @output subscribeInput, and getLastPointerType: the type of the latest
+ *   pointer event the stream delivered
  * @position The one entry for document-wide input listeners in core: one
  *   native listener per event type on the window's capture phase, shared by
  *   every subscriber
@@ -22,18 +23,21 @@
 // `blur` or `focus`. A subscriber for the window's own event checks
 // `event.target`.
 //
-// Subscribers run in subscription order. One that throws is reported, and
-// the rest still run.
+// Subscribers run in subscription order, after the ones subscribed `first`.
+// A first subscriber that returns `true` ends the dispatch: no later
+// subscriber hears the event. One that throws is reported, and the rest still
+// run.
 //
 // A type's native listener is passive, so it blocks no scroll. It is
 // non-passive only while a subscriber that cancels the event
 // (`{cancels: true}`) is subscribed. With no subscriber left, it is removed.
 
-type InputListener = (event: Event) => void;
+type InputListener = (event: Event) => unknown;
 
 interface Subscriber {
   readonly listener: InputListener;
   readonly cancels: boolean;
+  readonly isFirst: boolean;
 }
 
 interface Channel {
@@ -50,12 +54,30 @@ export interface InputSubscriptionOptions {
    * @default false
    */
   readonly cancels?: boolean;
+  /**
+   * The subscriber runs before every subscriber that is not first. When it
+   * returns `true`, no later subscriber hears the event.
+   * @default false
+   */
+  readonly first?: boolean;
 }
 
 /** The events a window's capture phase sees: its own, and the document's. */
 export type InputEventMap = WindowEventMap & DocumentEventMap;
 
 const streams = new WeakMap<Window, Map<string, Channel>>();
+/** The type of the latest pointer event each window's stream delivered. */
+const lastPointerTypes = new WeakMap<Window, string>();
+
+/**
+ * The type of the latest pointer event `view`'s stream delivered: `mouse`,
+ * `pen` or `touch`, or `null` before any. The stream hears a pointer event
+ * type only while a subscriber listens to it, as press feedback does on any
+ * page with a pressable. Reading it adds no listener.
+ */
+export function getLastPointerType(view: Window): string | null {
+  return lastPointerTypes.get(view) ?? null;
+}
 
 /**
  * Listen to `type` on `view`'s capture phase through its shared native
@@ -64,8 +86,8 @@ const streams = new WeakMap<Window, Map<string, Channel>>();
 export function subscribeInput<K extends keyof InputEventMap>(
   view: Window,
   type: K,
-  listener: (event: InputEventMap[K]) => void,
-  {cancels = false}: InputSubscriptionOptions = {},
+  listener: (event: InputEventMap[K]) => unknown,
+  {cancels = false, first = false}: InputSubscriptionOptions = {},
 ): () => void {
   let channels = streams.get(view);
   if (channels == null) {
@@ -80,8 +102,16 @@ export function subscribeInput<K extends keyof InputEventMap>(
   const subscriber: Subscriber = {
     listener: listener as InputListener,
     cancels,
+    isFirst: first,
   };
-  channel.subscribers.push(subscriber);
+  const firstLater = first
+    ? channel.subscribers.findIndex(other => !other.isFirst)
+    : -1;
+  if (firstLater === -1) {
+    channel.subscribers.push(subscriber);
+  } else {
+    channel.subscribers.splice(firstLater, 0, subscriber);
+  }
   register(view, type, channel);
   let isSubscribed = true;
   return () => {
@@ -124,12 +154,17 @@ function register(view: Window, type: string, channel: Channel): void {
   if (wanted == null) {
     return;
   }
-  const listener: InputListener = event => dispatch(channel, event);
+  const listener: InputListener = event => dispatch(view, channel, event);
   view.addEventListener(type, listener, {capture: true, passive: !wanted});
   channel.native = {listener, cancels: wanted};
 }
 
-function dispatch(channel: Channel, event: Event): void {
+function dispatch(view: Window, channel: Channel, event: Event): void {
+  // Recorded before any subscriber runs, so each reads the pointer at hand.
+  const {pointerType} = event as Partial<PointerEvent>;
+  if (typeof pointerType === 'string' && pointerType !== '') {
+    lastPointerTypes.set(view, pointerType);
+  }
   // A subscriber may subscribe or unsubscribe while the event runs; the
   // event goes to those subscribed when it arrived.
   for (const subscriber of [...channel.subscribers]) {
@@ -137,7 +172,9 @@ function dispatch(channel: Channel, event: Event): void {
       continue;
     }
     try {
-      subscriber.listener(event);
+      if (subscriber.listener(event) === true && subscriber.isFirst) {
+        return;
+      }
     } catch (error) {
       report(error);
     }