@workbench-kit/react 0.0.2-prototype.0.1.4 → 0.0.2-prototype.0.2.11

package/src/overlay/context-menu.css

@@ -0,0 +1,129 @@
+.ui-context-menu {
+  position: fixed;
+  z-index: var(--ui-context-menu-z-index, 260);
+  /* Hug content so short labels do not leave a wide empty hover strip. */
+  width: max-content;
+  min-width: 128px;
+  max-width: 300px;
+  /* Flush items to the frame so hover fills edge-to-edge. */
+  padding: 0;
+  color: var(--color-text);
+  background: var(--color-surface);
+  border: 1px solid var(--color-border);
+  border-radius: var(--radius-sm);
+  box-shadow: 0 8px 24px rgba(0, 0, 0, 0.35);
+  overflow: hidden;
+}
+
+.ui-context-menu__item {
+  --ui-button-width: 100%;
+  --ui-button-min-height: var(--workbench-context-menu-item-height);
+  --ui-button-height: auto;
+  --ui-button-display: grid;
+  /* Default: label only. Icon/shortcut columns are opt-in via data attrs. */
+  --ui-button-grid-template-columns: minmax(0, 1fr);
+  --ui-button-align-items: center;
+  --ui-button-justify-content: stretch;
+  --ui-button-gap: 7px;
+  --ui-button-padding: 0 10px;
+  --ui-button-border: 0;
+  --ui-button-border-radius: 0;
+  --ui-button-color: var(--color-text-muted);
+  --ui-button-background: transparent;
+  --ui-button-font-family: inherit;
+  --ui-button-font-size: var(--font-size-sm);
+  --ui-button-font-weight: 400;
+  --ui-button-text-align: left;
+  --ui-button-hover-color: var(--color-text);
+  --ui-button-hover-background: var(--color-surface-hover);
+  --ui-button-disabled-color: var(--color-text-subtle);
+  --ui-button-disabled-background: transparent;
+  box-sizing: border-box;
+  width: 100%;
+  min-height: var(--workbench-context-menu-item-height);
+  display: grid;
+  grid-template-columns: minmax(0, 1fr);
+  align-items: center;
+  gap: 7px;
+  padding: 0 10px;
+  border: 0;
+  border-radius: 0;
+  color: var(--color-text-muted);
+  background: transparent;
+  font-family: inherit;
+  font-size: var(--font-size-sm);
+  text-align: left;
+  cursor: pointer;
+}
+
+.ui-context-menu[data-has-shortcuts='true'] .ui-context-menu__item {
+  --ui-button-grid-template-columns: minmax(0, 1fr) auto;
+  grid-template-columns: minmax(0, 1fr) auto;
+}
+
+.ui-context-menu[data-has-icons='true'] .ui-context-menu__item {
+  --ui-button-grid-template-columns: 20px minmax(0, 1fr);
+  grid-template-columns: 20px minmax(0, 1fr);
+}
+
+.ui-context-menu[data-has-icons='true'][data-has-shortcuts='true'] .ui-context-menu__item {
+  --ui-button-grid-template-columns: 20px minmax(0, 1fr) auto;
+  grid-template-columns: 20px minmax(0, 1fr) auto;
+}
+
+.ui-context-menu__item:hover,
+.ui-context-menu__item:focus-visible,
+.ui-context-menu__item[data-highlighted='true'] {
+  color: var(--color-text);
+  background: var(--color-surface-hover);
+  outline: none;
+}
+
+.ui-context-menu__item:disabled {
+  color: var(--color-text-subtle);
+  background: transparent;
+  cursor: default;
+}
+
+.ui-context-menu__item[data-danger='true'] {
+  --ui-button-color: var(--color-danger);
+  --ui-button-hover-color: #fff;
+  --ui-button-hover-background: var(--color-danger);
+  color: var(--color-danger);
+}
+
+.ui-context-menu__item[data-danger='true']:hover,
+.ui-context-menu__item[data-danger='true']:focus-visible,
+.ui-context-menu__item[data-danger='true'][data-highlighted='true'] {
+  color: #fff;
+  background: var(--color-danger);
+}
+
+.ui-context-menu__icon {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  color: inherit;
+}
+
+.ui-context-menu__icon .codicon {
+  font-size: 14px;
+}
+
+.ui-context-menu__label {
+  min-width: 0;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+.ui-context-menu__shortcut {
+  color: var(--color-text-subtle);
+  font-size: 11px;
+}
+
+.ui-context-menu__separator {
+  height: 1px;
+  margin: 4px 0;
+  background: var(--color-border);
+}

package/src/overlay/index.ts

@@ -0,0 +1,31 @@
+export { ContextMenu } from './ContextMenu';
+export type { ContextMenuItem, ContextMenuProps } from './ContextMenu';
+export { measureAnchoredOverlayPanel } from './measureAnchoredOverlayPanel';
+export type {
+  AnchoredOverlayPanelRect,
+  AnchoredOverlayPlacement,
+  MeasureAnchoredOverlayPanelOptions,
+} from './measureAnchoredOverlayPanel';
+export { useAnchoredOverlayPanel } from './useAnchoredOverlayPanel';
+export type {
+  UseAnchoredOverlayPanelOptions,
+  UseAnchoredOverlayPanelResult,
+} from './useAnchoredOverlayPanel';
+export { useContextMenuState } from './useContextMenuState';
+export type {
+  ContextMenuPointerEvent,
+  ContextMenuPointerState,
+  UseContextMenuStateResult,
+} from './useContextMenuState';
+export {
+  createPointerPassthroughController,
+  isPointerOverHitRegion,
+} from './pointerPassthroughRegion';
+export type {
+  PointerOverHitRegionOptions,
+  PointerPassthroughController,
+  PointerPassthroughControllerOptions,
+  PointerPassthroughPort,
+} from './pointerPassthroughRegion';
+export { usePointerPassthroughRegion } from './usePointerPassthroughRegion';
+export type { UsePointerPassthroughRegionOptions } from './usePointerPassthroughRegion';

package/src/overlay/measureAnchoredOverlayPanel.ts

@@ -0,0 +1,107 @@
+export type AnchoredOverlayPlacement = 'side' | 'below' | 'above';
+
+export interface MeasureAnchoredOverlayPanelOptions {
+  readonly panelWidthPx?: number;
+  readonly viewportPaddingPx?: number;
+  readonly anchorGapPx?: number;
+  readonly maxHeightRatio?: number;
+  readonly sidePreferTriggerLeftRatio?: number;
+}
+
+export interface AnchoredOverlayPanelRect {
+  readonly top: number;
+  readonly left: number;
+  readonly width: number;
+  readonly maxHeight: number;
+  readonly placement: AnchoredOverlayPlacement;
+}
+
+const DEFAULT_PANEL_WIDTH_PX = 360;
+const DEFAULT_VIEWPORT_PADDING_PX = 8;
+const DEFAULT_ANCHOR_GAP_PX = 6;
+const DEFAULT_MAX_HEIGHT_RATIO = 0.72;
+const DEFAULT_SIDE_PREFER_TRIGGER_LEFT_RATIO = 0.42;
+/** Assumed minimum panel height when clamping side placement into the viewport. */
+const SIDE_MIN_VISIBLE_HEIGHT_PX = 240;
+/** Prefer below when at least this many pixels are available under the trigger. */
+const BELOW_MIN_SPACE_PX = 12;
+
+function clamp(value: number, min: number, max: number): number {
+  return Math.min(Math.max(value, min), max);
+}
+
+/**
+ * Measure a panel-sized overlay anchored to a trigger element.
+ * Prefers a side flyout when the trigger sits in the left portion of the
+ * viewport and there is room; otherwise places below or above.
+ */
+export function measureAnchoredOverlayPanel(
+  trigger: HTMLElement,
+  options: MeasureAnchoredOverlayPanelOptions = {},
+): AnchoredOverlayPanelRect {
+  const panelWidthPx = options.panelWidthPx ?? DEFAULT_PANEL_WIDTH_PX;
+  const viewportPaddingPx = options.viewportPaddingPx ?? DEFAULT_VIEWPORT_PADDING_PX;
+  const anchorGapPx = options.anchorGapPx ?? DEFAULT_ANCHOR_GAP_PX;
+  const maxHeightRatio = options.maxHeightRatio ?? DEFAULT_MAX_HEIGHT_RATIO;
+  const sidePreferTriggerLeftRatio =
+    options.sidePreferTriggerLeftRatio ?? DEFAULT_SIDE_PREFER_TRIGGER_LEFT_RATIO;
+
+  const viewportWidth = window.innerWidth;
+  const viewportHeight = window.innerHeight;
+  const triggerRect = trigger.getBoundingClientRect();
+
+  const maxHeight = Math.min(
+    viewportHeight * maxHeightRatio,
+    viewportHeight - viewportPaddingPx * 2,
+  );
+  const width = Math.min(panelWidthPx, viewportWidth - viewportPaddingPx * 2);
+
+  const spaceRight = Math.max(0, viewportWidth - triggerRect.right - viewportPaddingPx);
+  const spaceBelow = Math.max(0, viewportHeight - triggerRect.bottom - viewportPaddingPx);
+  const spaceAbove = Math.max(0, triggerRect.top - viewportPaddingPx);
+
+  const preferSide =
+    triggerRect.left < sidePreferTriggerLeftRatio * viewportWidth && spaceRight >= width;
+
+  if (preferSide) {
+    const minVisibleHeight = Math.min(SIDE_MIN_VISIBLE_HEIGHT_PX, maxHeight);
+    const top = clamp(
+      triggerRect.top,
+      viewportPaddingPx,
+      viewportHeight - viewportPaddingPx - minVisibleHeight,
+    );
+    return {
+      placement: 'side',
+      top,
+      left: triggerRect.right + anchorGapPx,
+      width,
+      maxHeight,
+    };
+  }
+
+  // Align the panel's right edge toward the trigger's right, then clamp.
+  const left = clamp(
+    triggerRect.right - width,
+    viewportPaddingPx,
+    viewportWidth - viewportPaddingPx - width,
+  );
+
+  if (spaceBelow >= BELOW_MIN_SPACE_PX || spaceBelow >= spaceAbove) {
+    return {
+      placement: 'below',
+      top: triggerRect.bottom + anchorGapPx,
+      left,
+      width,
+      maxHeight,
+    };
+  }
+
+  const aboveHeight = Math.min(maxHeight, spaceAbove);
+  return {
+    placement: 'above',
+    top: triggerRect.top - anchorGapPx - aboveHeight,
+    left,
+    width,
+    maxHeight,
+  };
+}

package/src/overlay/overlay.css

@@ -0,0 +1,2 @@
+/* Overlay surfaces */
+@import './context-menu.css';

package/src/overlay/pointerPassthroughRegion.ts

@@ -0,0 +1,83 @@
+export interface PointerPassthroughPort {
+  setPointerPassthrough(enabled: boolean): void | Promise<void>;
+}
+
+export interface PointerOverHitRegionOptions {
+  readonly hitSelectors: readonly string[];
+  readonly controlSelectors?: readonly string[];
+  readonly root?: HTMLElement | null;
+}
+
+/**
+ * Returns true when `target` matches any host-provided hit/control selector
+ * (and, when `root` is set, lies inside that root).
+ */
+export function isPointerOverHitRegion(
+  target: EventTarget | null,
+  options: PointerOverHitRegionOptions,
+): boolean {
+  if (!(target instanceof Element)) {
+    return false;
+  }
+
+  const root = options.root ?? null;
+  if (root !== null && !root.contains(target)) {
+    return false;
+  }
+
+  const selectors = [...options.hitSelectors, ...(options.controlSelectors ?? [])];
+  for (const selector of selectors) {
+    if (selector.length === 0) {
+      continue;
+    }
+    if (target.closest(selector) !== null) {
+      return true;
+    }
+  }
+  return false;
+}
+
+export interface PointerPassthroughControllerOptions extends PointerOverHitRegionOptions {
+  readonly enabled: boolean;
+  readonly port: PointerPassthroughPort;
+}
+
+export interface PointerPassthroughController {
+  handlePointerTarget(target: EventTarget | null): void;
+  /** Force the next decision to notify the port even if unchanged. */
+  reset(): void;
+}
+
+/**
+ * Pure controller for overlay click-through: when the pointer is outside
+ * host-provided selectors, ask the port to enable passthrough.
+ * Pair with platform `applyWindowResidency(..., 'click-through')` on the main side.
+ */
+export function createPointerPassthroughController(
+  options: PointerPassthroughControllerOptions,
+): PointerPassthroughController {
+  let lastPassthrough: boolean | null = null;
+
+  return {
+    reset() {
+      lastPassthrough = null;
+    },
+    handlePointerTarget(target: EventTarget | null) {
+      if (!options.enabled) {
+        if (lastPassthrough !== false) {
+          lastPassthrough = false;
+          void options.port.setPointerPassthrough(false);
+        }
+        return;
+      }
+
+      const overHit = isPointerOverHitRegion(target, options);
+      const passthrough = !overHit;
+      if (passthrough === lastPassthrough) {
+        return;
+      }
+      lastPassthrough = passthrough;
+      void options.port.setPointerPassthrough(passthrough);
+    },
+  };
+}

package/src/overlay/useAnchoredOverlayPanel.ts

@@ -0,0 +1,222 @@
+import {
+  useCallback,
+  useEffect,
+  useLayoutEffect,
+  useRef,
+  useState,
+  type CSSProperties,
+  type RefCallback,
+  type RefObject,
+} from 'react';
+
+import {
+  isSearchableMultiSelectPortalTarget,
+  resolvePortalContainer,
+} from '../primitives/searchable-multi-select/overlay';
+import {
+  measureAnchoredOverlayPanel,
+  type MeasureAnchoredOverlayPanelOptions,
+} from './measureAnchoredOverlayPanel';
+
+export interface UseAnchoredOverlayPanelOptions {
+  readonly open: boolean;
+  readonly onOpenChange: (open: boolean) => void;
+  readonly triggerRef: RefObject<HTMLElement | null>;
+  readonly panelRef?: RefObject<HTMLElement | null>;
+  readonly measureOptions?: MeasureAnchoredOverlayPanelOptions;
+  /** Extra "inside" predicates (e.g. host markers). */
+  readonly isInsideExtra?: (target: EventTarget | null) => boolean;
+}
+
+export interface UseAnchoredOverlayPanelResult {
+  readonly style: CSSProperties | null;
+  readonly portalRoot: HTMLElement;
+  readonly panelProps: {
+    /** Always a callback ref so it composes with host `panelRef` and panel shells. */
+    ref: RefCallback<HTMLElement>;
+    tabIndex: number;
+    style: CSSProperties | null;
+  };
+}
+
+function assignRef<T>(
+  ref: RefObject<T | null> | RefCallback<T> | null | undefined,
+  value: T | null,
+): void {
+  if (typeof ref === 'function') {
+    ref(value);
+    return;
+  }
+  if (ref) {
+    (ref as { current: T | null }).current = value;
+  }
+}
+
+function isInsideCatalogFilterOverlay(target: EventTarget | null): boolean {
+  if (!(target instanceof Element)) {
+    return false;
+  }
+  return target.closest('[data-ui-catalog-filter-overlay]') !== null;
+}
+
+/**
+ * Host-neutral anchored overlay panel helper: trigger-relative placement,
+ * viewport clamping, dismiss lifecycle, remeasure on resize/scroll, and portal root.
+ *
+ * Pair with `CatalogFilterOverlay` (or a similar panel shell). Unlike
+ * `useFixedOverlayDismiss`, scroll and resize remeasure instead of closing.
+ */
+export function useAnchoredOverlayPanel({
+  open,
+  onOpenChange,
+  triggerRef,
+  panelRef: externalPanelRef,
+  measureOptions,
+  isInsideExtra,
+}: UseAnchoredOverlayPanelOptions): UseAnchoredOverlayPanelResult {
+  const internalPanelRef = useRef<HTMLElement | null>(null);
+  const [style, setStyle] = useState<CSSProperties | null>(null);
+  const didFocusOnOpenRef = useRef(false);
+
+  const setPanelNode = useCallback<RefCallback<HTMLElement>>(
+    (node) => {
+      internalPanelRef.current = node;
+      assignRef(externalPanelRef, node);
+    },
+    [externalPanelRef],
+  );
+
+  const remeasure = useCallback(() => {
+    const trigger = triggerRef.current;
+    if (!open || !trigger) {
+      setStyle(null);
+      return;
+    }
+
+    const rect = measureAnchoredOverlayPanel(trigger, measureOptions);
+    setStyle({
+      position: 'fixed',
+      top: rect.top,
+      left: rect.left,
+      width: rect.width,
+      maxHeight: rect.maxHeight,
+    });
+  }, [measureOptions, open, triggerRef]);
+
+  useLayoutEffect(() => {
+    remeasure();
+  }, [remeasure]);
+
+  useEffect(() => {
+    if (!open) {
+      didFocusOnOpenRef.current = false;
+      return;
+    }
+
+    const handleResize = () => {
+      remeasure();
+    };
+    const handleScroll = () => {
+      remeasure();
+    };
+
+    window.addEventListener('resize', handleResize);
+    window.addEventListener('scroll', handleScroll, true);
+
+    return () => {
+      window.removeEventListener('resize', handleResize);
+      window.removeEventListener('scroll', handleScroll, true);
+    };
+  }, [open, remeasure]);
+
+  useEffect(() => {
+    if (!open) {
+      return;
+    }
+
+    const isInside = (target: EventTarget | null): boolean => {
+      const trigger = triggerRef.current;
+      const panel = internalPanelRef.current;
+      if (trigger && target instanceof Node && trigger.contains(target)) {
+        return true;
+      }
+      if (panel && target instanceof Node && panel.contains(target)) {
+        return true;
+      }
+      if (isInsideCatalogFilterOverlay(target)) {
+        return true;
+      }
+      if (isSearchableMultiSelectPortalTarget(target)) {
+        return true;
+      }
+      if (isInsideExtra?.(target)) {
+        return true;
+      }
+      return false;
+    };
+
+    const handleKeyDown = (event: KeyboardEvent) => {
+      if (event.key !== 'Escape') {
+        return;
+      }
+      if (event.defaultPrevented) {
+        return;
+      }
+      event.preventDefault();
+      onOpenChange(false);
+    };
+
+    const handlePointerDown = (event: PointerEvent) => {
+      if (event.defaultPrevented) {
+        return;
+      }
+      if (isInside(event.target)) {
+        return;
+      }
+      onOpenChange(false);
+    };
+
+    window.addEventListener('keydown', handleKeyDown);
+    window.addEventListener('pointerdown', handlePointerDown, true);
+
+    return () => {
+      window.removeEventListener('keydown', handleKeyDown);
+      window.removeEventListener('pointerdown', handlePointerDown, true);
+    };
+  }, [isInsideExtra, onOpenChange, open, triggerRef]);
+
+  useEffect(() => {
+    if (!open) {
+      return;
+    }
+    if (didFocusOnOpenRef.current) {
+      return;
+    }
+
+    const panel = internalPanelRef.current;
+    if (!panel) {
+      return;
+    }
+
+    const active = document.activeElement;
+    if (active instanceof Node && panel.contains(active)) {
+      didFocusOnOpenRef.current = true;
+      return;
+    }
+
+    panel.focus();
+    didFocusOnOpenRef.current = true;
+  }, [open, style]);
+
+  const portalRoot = resolvePortalContainer(triggerRef.current);
+
+  return {
+    style,
+    portalRoot,
+    panelProps: {
+      ref: setPanelNode,
+      tabIndex: -1,
+      style,
+    },
+  };
+}

package/src/overlay/useClampedFixedOverlayPosition.ts

@@ -0,0 +1,27 @@
+import { useEffect, useState, type RefObject } from 'react';
+import { clampFixedOverlayPosition } from './clampFixedOverlayPosition';
+
+export function useClampedFixedOverlayPosition(
+  containerRef: RefObject<HTMLElement | null>,
+  anchor: { x: number; y: number },
+  repositionKey: unknown,
+): { x: number; y: number } {
+  const [position, setPosition] = useState(anchor);
+
+  useEffect(() => {
+    setPosition(anchor);
+  }, [anchor.x, anchor.y]);
+
+  useEffect(() => {
+    const element = containerRef.current;
+    if (!element || typeof window === 'undefined') return;
+
+    const frame = window.requestAnimationFrame(() => {
+      setPosition(clampFixedOverlayPosition(anchor.x, anchor.y, element.getBoundingClientRect()));
+    });
+
+    return () => window.cancelAnimationFrame(frame);
+  }, [anchor.x, anchor.y, containerRef, repositionKey]);
+
+  return position;
+}

package/src/overlay/useContextMenuState.ts

@@ -0,0 +1,59 @@
+import { useCallback, useState } from 'react';
+
+export interface ContextMenuPointerState<T> {
+  readonly target: T;
+  readonly x: number;
+  readonly y: number;
+}
+
+/** Minimal pointer event shape accepted by `open` (React or DOM). */
+export interface ContextMenuPointerEvent {
+  readonly clientX: number;
+  readonly clientY: number;
+  preventDefault(): void;
+  stopPropagation(): void;
+}
+
+export interface UseContextMenuStateResult<T> {
+  readonly close: () => void;
+  readonly open: (event: ContextMenuPointerEvent, target: T) => void;
+  readonly openAt: (position: { readonly x: number; readonly y: number }, target: T) => void;
+  readonly state: ContextMenuPointerState<T> | null;
+}
+
+/**
+ * Host-owned context-menu pointer state (target + viewport coordinates).
+ * Does not build menu items or change selection — callers own those policies.
+ */
+export function useContextMenuState<T>(): UseContextMenuStateResult<T> {
+  const [state, setState] = useState<ContextMenuPointerState<T> | null>(null);
+
+  const close = useCallback(() => {
+    setState(null);
+  }, []);
+
+  const openAt = useCallback((position: { readonly x: number; readonly y: number }, target: T) => {
+    setState({
+      target,
+      x: position.x,
+      y: position.y,
+    });
+  }, []);
+
+  const open = useCallback((event: ContextMenuPointerEvent, target: T) => {
+    event.preventDefault();
+    event.stopPropagation();
+    setState({
+      target,
+      x: event.clientX,
+      y: event.clientY,
+    });
+  }, []);
+
+  return {
+    close,
+    open,
+    openAt,
+    state,
+  };
+}