@react-aria/utils 3.33.1 → 3.34.0

package/src/filterDOMProps.ts

@@ -1,127 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {AriaLabelingProps, DOMProps, GlobalDOMAttributes, LinkDOMProps} from '@react-types/shared';
-
-const DOMPropNames = new Set([
-  'id'
-]);
-
-const labelablePropNames = new Set([
-  'aria-label',
-  'aria-labelledby',
-  'aria-describedby',
-  'aria-details'
-]);
-
-// See LinkDOMProps in dom.d.ts.
-const linkPropNames = new Set([
-  'href',
-  'hrefLang',
-  'target',
-  'rel',
-  'download',
-  'ping',
-  'referrerPolicy'
-]);
-
-const globalAttrs = new Set([
-  'dir',
-  'lang',
-  'hidden',
-  'inert',
-  'translate'
-]);
-
-const globalEvents = new Set([
-  'onClick',
-  'onAuxClick',
-  'onContextMenu',
-  'onDoubleClick',
-  'onMouseDown',
-  'onMouseEnter',
-  'onMouseLeave',
-  'onMouseMove',
-  'onMouseOut',
-  'onMouseOver',
-  'onMouseUp',
-  'onTouchCancel',
-  'onTouchEnd',
-  'onTouchMove',
-  'onTouchStart',
-  'onPointerDown',
-  'onPointerMove',
-  'onPointerUp',
-  'onPointerCancel',
-  'onPointerEnter',
-  'onPointerLeave',
-  'onPointerOver',
-  'onPointerOut',
-  'onGotPointerCapture',
-  'onLostPointerCapture',
-  'onScroll',
-  'onWheel',
-  'onAnimationStart',
-  'onAnimationEnd',
-  'onAnimationIteration',
-  'onTransitionCancel',
-  'onTransitionEnd',
-  'onTransitionRun',
-  'onTransitionStart'
-]);
-
-interface Options {
-  /**
-   * If labelling associated aria properties should be included in the filter.
-   */
-  labelable?: boolean,
-  /** Whether the element is a link and should include DOM props for <a> elements. */
-  isLink?: boolean,
-  /** Whether to include global DOM attributes. */
-  global?: boolean,
-  /** Whether to include DOM events. */
-  events?: boolean,
-  /**
-   * A Set of other property names that should be included in the filter.
-   */
-  propNames?: Set<string>
-}
-
-const propRe = /^(data-.*)$/;
-
-/**
- * Filters out all props that aren't valid DOM props or defined via override prop obj.
- * @param props - The component props to be filtered.
- * @param opts - Props to override.
- */
-export function filterDOMProps(props: DOMProps & AriaLabelingProps & LinkDOMProps & GlobalDOMAttributes, opts: Options = {}): DOMProps & AriaLabelingProps & GlobalDOMAttributes {
-  let {labelable, isLink, global, events = global, propNames} = opts;
-  let filteredProps = {};
-
-  for (const prop in props) {
-    if (
-      Object.prototype.hasOwnProperty.call(props, prop) && (
-        DOMPropNames.has(prop) ||
-        (labelable && labelablePropNames.has(prop)) ||
-        (isLink && linkPropNames.has(prop)) ||
-        (global && globalAttrs.has(prop)) ||
-        (events && (globalEvents.has(prop) || (prop.endsWith('Capture') && globalEvents.has(prop.slice(0, -7))))) ||
-        propNames?.has(prop) ||
-        propRe.test(prop)
-      )
-    ) {
-      filteredProps[prop] = props[prop];
-    }
-  }
-
-  return filteredProps;
-}

package/src/focusWithoutScrolling.ts

@@ -1,96 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {FocusableElement} from '@react-types/shared';
-
-// This is a polyfill for element.focus({preventScroll: true});
-// Currently necessary for Safari and old Edge:
-// https://caniuse.com/#feat=mdn-api_htmlelement_focus_preventscroll_option
-// See https://bugs.webkit.org/show_bug.cgi?id=178583
-//
-
-// Original licensing for the following methods can be found in the
-// NOTICE file in the root directory of this source tree.
-// See https://github.com/calvellido/focus-options-polyfill
-
-interface ScrollableElement {
-  element: HTMLElement,
-  scrollTop: number,
-  scrollLeft: number
-}
-
-export function focusWithoutScrolling(element: FocusableElement): void {
-  if (supportsPreventScroll()) {
-    element.focus({preventScroll: true});
-  } else {
-    let scrollableElements = getScrollableElements(element);
-    element.focus();
-    restoreScrollPosition(scrollableElements);
-  }
-}
-
-let supportsPreventScrollCached: boolean | null = null;
-function supportsPreventScroll() {
-  if (supportsPreventScrollCached == null) {
-    supportsPreventScrollCached = false;
-    try {
-      let focusElem = document.createElement('div');
-      focusElem.focus({
-        get preventScroll() {
-          supportsPreventScrollCached = true;
-          return true;
-        }
-      });
-    } catch {
-      // Ignore
-    }
-  }
-
-  return supportsPreventScrollCached;
-}
-
-function getScrollableElements(element: FocusableElement): ScrollableElement[] {
-  let parent = element.parentNode;
-  let scrollableElements: ScrollableElement[] = [];
-  let rootScrollingElement = document.scrollingElement || document.documentElement;
-
-  while (parent instanceof HTMLElement && parent !== rootScrollingElement) {
-    if (
-      parent.offsetHeight < parent.scrollHeight ||
-      parent.offsetWidth < parent.scrollWidth
-    ) {
-      scrollableElements.push({
-        element: parent,
-        scrollTop: parent.scrollTop,
-        scrollLeft: parent.scrollLeft
-      });
-    }
-    parent = parent.parentNode;
-  }
-
-  if (rootScrollingElement instanceof HTMLElement) {
-    scrollableElements.push({
-      element: rootScrollingElement,
-      scrollTop: rootScrollingElement.scrollTop,
-      scrollLeft: rootScrollingElement.scrollLeft
-    });
-  }
-
-  return scrollableElements;
-}
-
-function restoreScrollPosition(scrollableElements: ScrollableElement[]) {
-  for (let {element, scrollTop, scrollLeft} of scrollableElements) {
-    element.scrollTop = scrollTop;
-    element.scrollLeft = scrollLeft;
-  }
-}

package/src/getOffset.ts

@@ -1,21 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {Orientation} from '@react-types/shared';
-
-export function getOffset(element: HTMLElement, reverse?: boolean, orientation: Orientation = 'horizontal'): number {
-  let rect = element.getBoundingClientRect();
-  if (reverse) {
-    return orientation === 'horizontal' ? rect.right : rect.bottom;
-  }
-  return orientation === 'horizontal' ? rect.left : rect.top;
-}

package/src/getScrollParent.ts

@@ -1,27 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {isScrollable} from './isScrollable';
-
-export function getScrollParent(node: Element, checkForOverflow?: boolean): Element {
-  let scrollableNode: Element | null = node;
-  if (isScrollable(scrollableNode, checkForOverflow)) {
-    scrollableNode = scrollableNode.parentElement;
-  }
-
-  while (scrollableNode && !isScrollable(scrollableNode, checkForOverflow)) {
-    scrollableNode = scrollableNode.parentElement;
-  }
-
-  return scrollableNode || document.scrollingElement || document.documentElement;
-}
-

package/src/getScrollParents.ts

@@ -1,27 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {isScrollable} from './isScrollable';
-
-export function getScrollParents(node: Element, checkForOverflow?: boolean): Element[] {
-  let parentElements: Element[] = [];
-  let root = document.scrollingElement || document.documentElement;
-
-  do {
-    if (isScrollable(node, checkForOverflow)) {
-      parentElements.push(node);
-    }
-    node = node.parentElement as Element;
-  } while (node && node !== root);
-
-  return parentElements;
-}

package/src/inertValue.ts

@@ -1,11 +0,0 @@
-import {version} from 'react';
-
-export function inertValue(value?: boolean): string | boolean | undefined {
-  const pieces = version.split('.');
-  const major = parseInt(pieces[0], 10);
-  if (major >= 19) {
-    return value;
-  }
-  // compatibility with React < 19
-  return value ? 'true' : undefined;
-}

package/src/isElementVisible.ts

@@ -1,75 +0,0 @@
-/*
- * Copyright 2021 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {getOwnerWindow} from './domHelpers';
-
-const supportsCheckVisibility = typeof Element !== 'undefined' && 'checkVisibility' in Element.prototype;
-
-function isStyleVisible(element: Element) {
-  const windowObject = getOwnerWindow(element);
-  if (!(element instanceof windowObject.HTMLElement) && !(element instanceof windowObject.SVGElement)) {
-    return false;
-  }
-
-  let {display, visibility} = element.style;
-
-  let isVisible = (
-    display !== 'none' &&
-    visibility !== 'hidden' &&
-    visibility !== 'collapse'
-  );
-
-  if (isVisible) {
-    const {getComputedStyle} = element.ownerDocument.defaultView as unknown as Window;
-    let {display: computedDisplay, visibility: computedVisibility} = getComputedStyle(element);
-
-    isVisible = (
-      computedDisplay !== 'none' &&
-      computedVisibility !== 'hidden' &&
-      computedVisibility !== 'collapse'
-    );
-  }
-
-  return isVisible;
-}
-
-function isAttributeVisible(element: Element, childElement?: Element) {
-  return (
-    !element.hasAttribute('hidden') &&
-    // Ignore HiddenSelect when tree walking.
-    !element.hasAttribute('data-react-aria-prevent-focus') &&
-    (element.nodeName === 'DETAILS' &&
-      childElement &&
-      childElement.nodeName !== 'SUMMARY'
-      ? element.hasAttribute('open')
-      : true)
-  );
-}
-
-/**
- * Adapted from https://github.com/testing-library/jest-dom and
- * https://github.com/vuejs/vue-test-utils-next/.
- * Licensed under the MIT License.
- * @param element - Element to evaluate for display or visibility.
- */
-export function isElementVisible(element: Element, childElement?: Element): boolean {
-  if (supportsCheckVisibility) {
-    return element.checkVisibility({visibilityProperty: true}) && !element.closest('[data-react-aria-prevent-focus]');
-  }
-
-  return (
-    element.nodeName !== '#comment' &&
-    isStyleVisible(element) &&
-    isAttributeVisible(element, childElement) &&
-    (!element.parentElement || isElementVisible(element.parentElement, element))
-  );
-}

package/src/isFocusable.ts

@@ -1,56 +0,0 @@
-/*
- * Copyright 2025 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {isElementVisible} from './isElementVisible';
-
-const focusableElements = [
-  'input:not([disabled]):not([type=hidden])',
-  'select:not([disabled])',
-  'textarea:not([disabled])',
-  'button:not([disabled])',
-  'a[href]',
-  'area[href]',
-  'summary',
-  'iframe',
-  'object',
-  'embed',
-  'audio[controls]',
-  'video[controls]',
-  '[contenteditable]:not([contenteditable^="false"])',
-  'permission'
-];
-
-const FOCUSABLE_ELEMENT_SELECTOR = focusableElements.join(':not([hidden]),') + ',[tabindex]:not([disabled]):not([hidden])';
-
-focusableElements.push('[tabindex]:not([tabindex="-1"]):not([disabled])');
-const TABBABLE_ELEMENT_SELECTOR = focusableElements.join(':not([hidden]):not([tabindex="-1"]),');
-
-export function isFocusable(element: Element): boolean {
-  return element.matches(FOCUSABLE_ELEMENT_SELECTOR) && isElementVisible(element) && !isInert(element);
-}
-
-export function isTabbable(element: Element): boolean {
-  return element.matches(TABBABLE_ELEMENT_SELECTOR) && isElementVisible(element) && !isInert(element);
-}
-
-function isInert(element: Element): boolean {
-  let node: Element | null = element;
-  while (node != null) {
-    if (node instanceof node.ownerDocument.defaultView!.HTMLElement && node.inert) {
-      return true;
-    }
-
-    node = node.parentElement;
-  }
-
-  return false;
-}

package/src/isScrollable.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-export function isScrollable(node: Element | null, checkForOverflow?: boolean): boolean {
-  if (!node) {
-    return false;
-  }
-  let style = window.getComputedStyle(node);
-  let root = document.scrollingElement || document.documentElement;
-  let isScrollable = /(auto|scroll)/.test(style.overflow + style.overflowX + style.overflowY);
-
-  // Root element has `visible` overflow by default, but is scrollable nonetheless.
-  if (node === root && style.overflow !== 'hidden') {
-    isScrollable = true;
-  }
-
-  if (isScrollable && checkForOverflow) {
-    isScrollable = node.scrollHeight !== node.clientHeight || node.scrollWidth !== node.clientWidth;
-  }
-
-  return isScrollable;
-}

package/src/isVirtualEvent.ts

@@ -1,58 +0,0 @@
-/*
- * Copyright 2022 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {isAndroid} from './platform';
-
-// Original licensing for the following method can be found in the
-// NOTICE file in the root directory of this source tree.
-// See https://github.com/facebook/react/blob/3c713d513195a53788b3f8bb4b70279d68b15bcc/packages/react-interactions/events/src/dom/shared/index.js#L74-L87
-
-// Keyboards, Assistive Technologies, and element.click() all produce a "virtual"
-// click event. This is a method of inferring such clicks. Every browser except
-// IE 11 only sets a zero value of "detail" for click events that are "virtual".
-// However, IE 11 uses a zero value for all click events. For IE 11 we rely on
-// the quirk that it produces click events that are of type PointerEvent, and
-// where only the "virtual" click lacks a pointerType field.
-
-export function isVirtualClick(event: MouseEvent | PointerEvent): boolean {
-  // JAWS/NVDA with Firefox.
-  if ((event as PointerEvent).pointerType === '' && event.isTrusted) {
-    return true;
-  }
-
-  // Android TalkBack's detail value varies depending on the event listener providing the event so we have specific logic here instead
-  // If pointerType is defined, event is from a click listener. For events from mousedown listener, detail === 0 is a sufficient check
-  // to detect TalkBack virtual clicks.
-  if (isAndroid() && (event as PointerEvent).pointerType) {
-    return event.type === 'click' && event.buttons === 1;
-  }
-
-  return event.detail === 0 && !(event as PointerEvent).pointerType;
-}
-
-export function isVirtualPointerEvent(event: PointerEvent): boolean {
-  // If the pointer size is zero, then we assume it's from a screen reader.
-  // Android TalkBack double tap will sometimes return a event with width and height of 1
-  // and pointerType === 'mouse' so we need to check for a specific combination of event attributes.
-  // Cannot use "event.pressure === 0" as the sole check due to Safari pointer events always returning pressure === 0
-  // instead of .5, see https://bugs.webkit.org/show_bug.cgi?id=206216. event.pointerType === 'mouse' is to distingush
-  // Talkback double tap from Windows Firefox touch screen press
-  return (
-    (!isAndroid() && event.width === 0 && event.height === 0) ||
-    (event.width === 1 &&
-      event.height === 1 &&
-      event.pressure === 0 &&
-      event.detail === 0 &&
-      event.pointerType === 'mouse'
-    )
-  );
-}

package/src/keyboard.tsx

@@ -1,48 +0,0 @@
-/*
- * Copyright 2024 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {isMac} from './platform';
-
-interface Event {
-  altKey: boolean,
-  ctrlKey: boolean,
-  metaKey: boolean
-}
-
-export function isCtrlKeyPressed(e: Event): boolean {
-  if (isMac()) {
-    return e.metaKey;
-  }
-
-  return e.ctrlKey;
-}
-
-// HTML input types that do not cause the software keyboard to appear.
-const nonTextInputTypes = new Set([
-  'checkbox',
-  'radio',
-  'range',
-  'color',
-  'file',
-  'image',
-  'button',
-  'submit',
-  'reset'
-]);
-
-export function willOpenKeyboard(target: Element) {
-  return (
-    (target instanceof HTMLInputElement && !nonTextInputTypes.has(target.type)) ||
-    target instanceof HTMLTextAreaElement ||
-    (target instanceof HTMLElement && target.isContentEditable)
-  );
-}

package/src/mergeProps.ts

@@ -1,77 +0,0 @@
-/*
- * Copyright 2020 Adobe. All rights reserved.
- * This file is licensed to you under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License. You may obtain a copy
- * of the License at http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software distributed under
- * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
- * OF ANY KIND, either express or implied. See the License for the specific language
- * governing permissions and limitations under the License.
- */
-
-import {chain} from './chain';
-import clsx from 'clsx';
-import {mergeIds} from './useId';
-import {mergeRefs} from './mergeRefs';
-
-interface Props {
-  [key: string]: any
-}
-
-type PropsArg = Props | null | undefined;
-
-// taken from: https://stackoverflow.com/questions/51603250/typescript-3-parameter-list-intersection-type/51604379#51604379
-type TupleTypes<T> = { [P in keyof T]: T[P] } extends { [key: number]: infer V } ? NullToObject<V> : never;
-type NullToObject<T> = T extends (null | undefined) ? {} : T;
-
-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
-
-/**
- * Merges multiple props objects together. Event handlers are chained,
- * classNames are combined, ids are deduplicated, and refs are merged.
- * For all other props, the last prop object overrides all previous ones.
- * @param args - Multiple sets of props to merge together.
- */
-export function mergeProps<T extends PropsArg[]>(...args: T): UnionToIntersection<TupleTypes<T>> {
-  // Start with a base clone of the first argument. This is a lot faster than starting
-  // with an empty object and adding properties as we go.
-  let result: Props = {...args[0]};
-  for (let i = 1; i < args.length; i++) {
-    let props = args[i];
-    for (let key in props) {
-      let a = result[key];
-      let b = props[key];
-
-      // Chain events
-      if (
-        typeof a === 'function' &&
-        typeof b === 'function' &&
-        // This is a lot faster than a regex.
-        key[0] === 'o' &&
-        key[1] === 'n' &&
-        key.charCodeAt(2) >= /* 'A' */ 65 &&
-        key.charCodeAt(2) <= /* 'Z' */ 90
-      ) {
-        result[key] = chain(a, b);
-
-        // Merge classnames, sometimes classNames are empty string which eval to false, so we just need to do a type check
-      } else if (
-        (key === 'className' || key === 'UNSAFE_className') &&
-        typeof a === 'string' &&
-        typeof b === 'string'
-      ) {
-        result[key] = clsx(a, b);
-      } else if (key === 'id' && a && b) {
-        result.id = mergeIds(a, b);
-      } else if (key === 'ref' && a && b) {
-        result.ref = mergeRefs(a, b);
-        // Override others
-      } else {
-        result[key] = b !== undefined ? b : a;
-      }
-    }
-  }
-
-  return result as UnionToIntersection<TupleTypes<T>>;
-}