@react-aria/menu 3.20.0 → 3.22.0

package/src/useMenuItem.ts

@@ -1,350 +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 {DOMAttributes, DOMProps, FocusableElement, FocusEvents, HoverEvents, Key, KeyboardEvents, PressEvent, PressEvents, RefObject} from '@react-types/shared';
-import {filterDOMProps, handleLinkClick, mergeProps, useLinkProps, useRouter, useSlotId} from '@react-aria/utils';
-import {getItemCount} from '@react-stately/collections';
-import {isFocusVisible, useFocusable, useHover, useKeyboard, usePress} from '@react-aria/interactions';
-import {menuData} from './utils';
-import {MouseEvent, useRef} from 'react';
-import {SelectionManager} from '@react-stately/selection';
-import {TreeState} from '@react-stately/tree';
-import {useSelectableItem} from '@react-aria/selection';
-
-export interface MenuItemAria {
-  /** Props for the menu item element. */
-  menuItemProps: DOMAttributes,
-
-  /** Props for the main text element inside the menu item. */
-  labelProps: DOMAttributes,
-
-  /** Props for the description text element inside the menu item, if any. */
-  descriptionProps: DOMAttributes,
-
-  /** Props for the keyboard shortcut text element inside the item, if any. */
-  keyboardShortcutProps: DOMAttributes,
-
-  /** Whether the item is currently focused. */
-  isFocused: boolean,
-  /** Whether the item is keyboard focused. */
-  isFocusVisible: boolean,
-  /** Whether the item is currently selected. */
-  isSelected: boolean,
-  /** Whether the item is currently in a pressed state. */
-  isPressed: boolean,
-  /** Whether the item is disabled. */
-  isDisabled: boolean
-}
-
-export interface AriaMenuItemProps extends DOMProps, PressEvents, HoverEvents, KeyboardEvents, FocusEvents  {
-  /**
-   * Whether the menu item is disabled.
-   * @deprecated - pass disabledKeys to useTreeState instead.
-   */
-  isDisabled?: boolean,
-
-  /**
-   * Whether the menu item is selected.
-   * @deprecated - pass selectedKeys to useTreeState instead.
-   */
-  isSelected?: boolean,
-
-  /** A screen reader only label for the menu item. */
-  'aria-label'?: string,
-
-  /** The unique key for the menu item. */
-  key: Key,
-
-  /**
-   * Handler that is called when the menu should close after selecting an item.
-   * @deprecated - pass to the menu instead.
-   */
-  onClose?: () => void,
-
-  /**
-   * Whether the menu should close when the menu item is selected.
-   * @deprecated - use shouldCloseOnSelect instead.
-   */
-  closeOnSelect?: boolean,
-
-  /** Whether the menu should close when the menu item is selected. */
-  shouldCloseOnSelect?: boolean,
-
-  /** Whether the menu item is contained in a virtual scrolling menu. */
-  isVirtualized?: boolean,
-
-  /**
-   * Handler that is called when the user activates the item.
-   * @deprecated - pass to the menu instead.
-   */
-  onAction?: (key: Key) => void,
-
-  /** What kind of popup the item opens. */
-  'aria-haspopup'?: 'menu' | 'dialog',
-
-  /** Indicates whether the menu item's popup element is expanded or collapsed. */
-  'aria-expanded'?: boolean | 'true' | 'false',
-
-  /** Identifies the menu item's popup element whose contents or presence is controlled by the menu item. */
-  'aria-controls'?: string,
-
-  /** Override of the selection manager. By default, `state.selectionManager` is used. */
-  selectionManager?: SelectionManager
-}
-
-/**
- * Provides the behavior and accessibility implementation for an item in a menu.
- * See `useMenu` for more details about menus.
- * @param props - Props for the item.
- * @param state - State for the menu, as returned by `useTreeState`.
- */
-export function useMenuItem<T>(props: AriaMenuItemProps, state: TreeState<T>, ref: RefObject<FocusableElement | null>): MenuItemAria {
-  let {
-    id,
-    key,
-    closeOnSelect,
-    shouldCloseOnSelect,
-    isVirtualized,
-    'aria-haspopup': hasPopup,
-    onPressStart,
-    onPressUp: pressUpProp,
-    onPress,
-    onPressChange: pressChangeProp,
-    onPressEnd,
-    onClick: onClickProp,
-    onHoverStart: hoverStartProp,
-    onHoverChange,
-    onHoverEnd,
-    onKeyDown,
-    onKeyUp,
-    onFocus,
-    onFocusChange,
-    onBlur,
-    selectionManager = state.selectionManager
-  } = props;
-
-  let isTrigger = !!hasPopup;
-  let isTriggerExpanded = isTrigger && props['aria-expanded'] === 'true';
-  let isDisabled = props.isDisabled ?? selectionManager.isDisabled(key);
-  let isSelected = props.isSelected ?? selectionManager.isSelected(key);
-  let data = menuData.get(state)!;
-  let item = state.collection.getItem(key);
-  let onClose = props.onClose || data.onClose;
-  let router = useRouter();
-  let performAction = () => {
-    if (isTrigger) {
-      return;
-    }
-
-    if (item?.props?.onAction) {
-      item.props.onAction();
-    } else if (props.onAction) {
-      props.onAction(key);
-    }
-
-    if (data.onAction) {
-      // Must reassign to variable otherwise `this` binding gets messed up. Something to do with WeakMap.
-      let onAction = data.onAction;
-      onAction(key);
-    }
-  };
-
-  let role = 'menuitem';
-  if (!isTrigger) {
-    if (selectionManager.selectionMode === 'single') {
-      role = 'menuitemradio';
-    } else if (selectionManager.selectionMode === 'multiple') {
-      role = 'menuitemcheckbox';
-    }
-  }
-
-  let labelId = useSlotId();
-  let descriptionId = useSlotId();
-  let keyboardId = useSlotId();
-
-  let ariaProps = {
-    id,
-    'aria-disabled': isDisabled || undefined,
-    role,
-    'aria-label': props['aria-label'],
-    'aria-labelledby': labelId,
-    'aria-describedby': [descriptionId, keyboardId].filter(Boolean).join(' ') || undefined,
-    'aria-controls': props['aria-controls'],
-    'aria-haspopup': hasPopup,
-    'aria-expanded': props['aria-expanded']
-  };
-
-  if (selectionManager.selectionMode !== 'none' && !isTrigger) {
-    ariaProps['aria-checked'] = isSelected;
-  }
-
-  if (isVirtualized) {
-    ariaProps['aria-posinset'] = item?.index;
-    ariaProps['aria-setsize'] = getItemCount(state.collection);
-  }
-
-  let isPressedRef = useRef(false);
-  let onPressChange = (isPressed: boolean) => {
-    pressChangeProp?.(isPressed);
-    isPressedRef.current = isPressed;
-  };
-
-  let interaction = useRef<{pointerType: string, key?: string} | null>(null);
-  let onPressUp = (e: PressEvent) => {
-    if (e.pointerType !== 'keyboard') {
-      interaction.current = {pointerType: e.pointerType};
-    }
-
-    // If interacting with mouse, allow the user to mouse down on the trigger button,
-    // drag, and release over an item (matching native behavior).
-    if (e.pointerType === 'mouse') {
-      if (!isPressedRef.current) {
-        (e.target as HTMLElement).click();
-      }
-    }
-
-    pressUpProp?.(e);
-  };
-
-  let onClick = (e: MouseEvent<FocusableElement>) => {
-    onClickProp?.(e);
-    performAction();
-    handleLinkClick(e, router, item!.props.href, item?.props.routerOptions);
-
-    let shouldClose = interaction.current?.pointerType === 'keyboard'
-      // Always close when pressing Enter key, or if item is not selectable.
-      ? interaction.current?.key === 'Enter' || selectionManager.selectionMode === 'none' || selectionManager.isLink(key)
-      // Close except if multi-select is enabled.
-      : selectionManager.selectionMode !== 'multiple' || selectionManager.isLink(key);
-
-
-    shouldClose = shouldCloseOnSelect ?? closeOnSelect ?? shouldClose;
-
-    if (onClose && !isTrigger && shouldClose) {
-      onClose();
-    }
-
-    interaction.current = null;
-  };
-
-  let {itemProps, isFocused} = useSelectableItem({
-    id,
-    selectionManager: selectionManager,
-    key,
-    ref,
-    shouldSelectOnPressUp: true,
-    allowsDifferentPressOrigin: true,
-    // Disable all handling of links in useSelectable item
-    // because we handle it ourselves. The behavior of menus
-    // is slightly different from other collections because
-    // actions are performed on key down rather than key up.
-    linkBehavior: 'none',
-    shouldUseVirtualFocus: data.shouldUseVirtualFocus
-  });
-
-  let {pressProps, isPressed} = usePress({
-    onPressStart,
-    onPress,
-    onPressUp,
-    onPressChange,
-    onPressEnd,
-    isDisabled
-  });
-  let {hoverProps} = useHover({
-    isDisabled,
-    onHoverStart(e) {
-      // Hovering over an already expanded sub dialog trigger should keep focus in the dialog.
-      if (!isFocusVisible() && !(isTriggerExpanded && hasPopup)) {
-        selectionManager.setFocused(true);
-        selectionManager.setFocusedKey(key);
-      }
-      hoverStartProp?.(e);
-    },
-    onHoverChange,
-    onHoverEnd
-  });
-
-  let {keyboardProps} = useKeyboard({
-    onKeyDown: (e) => {
-      // Ignore repeating events, which may have started on the menu trigger before moving
-      // focus to the menu item. We want to wait for a second complete key press sequence.
-      if (e.repeat) {
-        e.continuePropagation();
-        return;
-      }
-
-      switch (e.key) {
-        case ' ':
-          interaction.current = {pointerType: 'keyboard', key: ' '};
-          (e.target as HTMLElement).click();
-          break;
-        case 'Enter':
-          interaction.current = {pointerType: 'keyboard', key: 'Enter'};
-
-          // Trigger click unless this is a link. Links trigger click natively.
-          if ((e.target as HTMLElement).tagName !== 'A') {
-            (e.target as HTMLElement).click();
-          }
-          break;
-        default:
-          if (!isTrigger) {
-            e.continuePropagation();
-          }
-
-          onKeyDown?.(e);
-          break;
-      }
-    },
-    onKeyUp
-  });
-
-  let {focusableProps} = useFocusable({onBlur, onFocus, onFocusChange}, ref);
-  let domProps = filterDOMProps(item?.props);
-  delete domProps.id;
-  let linkProps = useLinkProps(item?.props);
-
-  return {
-    menuItemProps: {
-      ...ariaProps,
-      ...mergeProps(
-        domProps,
-        linkProps,
-        isTrigger
-          ? {onFocus: itemProps.onFocus, 'data-collection': itemProps['data-collection'], 'data-key': itemProps['data-key']}
-          : itemProps,
-        pressProps,
-        hoverProps,
-        keyboardProps,
-        focusableProps,
-        // Prevent DOM focus from moving on mouse down when using virtual focus or this is a submenu/subdialog trigger.
-        data.shouldUseVirtualFocus || isTrigger ? {onMouseDown: e => e.preventDefault()} : undefined,
-        isDisabled ? undefined : {onClick}
-      ),
-      // If a submenu is expanded, set the tabIndex to -1 so that shift tabbing goes out of the menu instead of the parent menu item.
-      tabIndex: itemProps.tabIndex != null && isTriggerExpanded && !data.shouldUseVirtualFocus ? -1 : itemProps.tabIndex
-    },
-    labelProps: {
-      id: labelId
-    },
-    descriptionProps: {
-      id: descriptionId
-    },
-    keyboardShortcutProps: {
-      id: keyboardId
-    },
-    isFocused,
-    isFocusVisible: isFocused && selectionManager.isFocused && isFocusVisible() && !isTriggerExpanded,
-    isSelected,
-    isPressed,
-    isDisabled
-  };
-}

package/src/useMenuSection.ts

@@ -1,61 +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 {DOMAttributes} from '@react-types/shared';
-import {ReactNode} from 'react';
-import {useId} from '@react-aria/utils';
-
-export interface AriaMenuSectionProps {
-  /** The heading for the section. */
-  heading?: ReactNode,
-  /** An accessibility label for the section. Required if `heading` is not present. */
-  'aria-label'?: string
-}
-
-export interface MenuSectionAria {
-  /** Props for the wrapper list item. */
-  itemProps: DOMAttributes,
-
-  /** Props for the heading element, if any. */
-  headingProps: DOMAttributes,
-
-  /** Props for the group element. */
-  groupProps: DOMAttributes
-}
-
-/**
- * Provides the behavior and accessibility implementation for a section in a menu.
- * See `useMenu` for more details about menus.
- * @param props - Props for the section.
- */
-export function useMenuSection(props: AriaMenuSectionProps): MenuSectionAria {
-  let {heading, 'aria-label': ariaLabel} = props;
-  let headingId = useId();
-
-  return {
-    itemProps: {
-      role: 'presentation'
-    },
-    headingProps: heading ? {
-      // Techincally, menus cannot contain headings according to ARIA.
-      // We hide the heading from assistive technology, using role="presentation",
-      // and only use it as a label for the nested group.
-      id: headingId,
-      role: 'presentation'
-    } : {},
-    groupProps: {
-      role: 'group',
-      'aria-label': ariaLabel,
-      'aria-labelledby': heading ? headingId : undefined
-    }
-  };
-}

package/src/useMenuTrigger.ts

@@ -1,156 +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 {AriaButtonProps} from '@react-types/button';
-import {AriaMenuOptions} from './useMenu';
-import {FocusableElement, RefObject} from '@react-types/shared';
-import {focusWithoutScrolling, useId} from '@react-aria/utils';
-// @ts-ignore
-import intlMessages from '../intl/*.json';
-import {MenuTriggerState} from '@react-stately/menu';
-import {MenuTriggerType} from '@react-types/menu';
-import {PressProps, useLongPress} from '@react-aria/interactions';
-import {useLocalizedStringFormatter} from '@react-aria/i18n';
-import {useOverlayTrigger} from '@react-aria/overlays';
-
-export interface AriaMenuTriggerProps {
-  /** The type of menu that the menu trigger opens. */
-  type?: 'menu' | 'listbox',
-  /** Whether menu trigger is disabled. */
-  isDisabled?: boolean,
-  /** How menu is triggered. */
-  trigger?: MenuTriggerType
-}
-
-export interface MenuTriggerAria<T> {
-  /** Props for the menu trigger element. */
-  menuTriggerProps: AriaButtonProps,
-
-  /** Props for the menu. */
-  menuProps: AriaMenuOptions<T>
-}
-
-/**
- * Provides the behavior and accessibility implementation for a menu trigger.
- * @param props - Props for the menu trigger.
- * @param state - State for the menu trigger.
- * @param ref - Ref to the HTML element trigger for the menu.
- */
-export function useMenuTrigger<T>(props: AriaMenuTriggerProps, state: MenuTriggerState, ref: RefObject<Element | null>): MenuTriggerAria<T> {
-  let {
-    type = 'menu',
-    isDisabled,
-    trigger = 'press'
-  } = props;
-
-  let menuTriggerId = useId();
-  let {triggerProps, overlayProps} = useOverlayTrigger({type}, state, ref);
-
-  let onKeyDown = (e) => {
-    if (isDisabled) {
-      return;
-    }
-
-    if (trigger === 'longPress' && !e.altKey) {
-      return;
-    }
-
-    if (ref && ref.current) {
-      switch (e.key) {
-        case 'Enter':
-        case ' ':
-          // React puts listeners on the same root, so even if propagation was stopped, immediate propagation is still possible.
-          // useTypeSelect will handle the spacebar first if it's running, so we don't want to open if it's handled it already.
-          // We use isDefaultPrevented() instead of isPropagationStopped() because createEventHandler stops propagation by default.
-          // And default prevented means that the event was handled by something else (typeahead), so we don't want to open the menu.
-          if (trigger === 'longPress' || e.isDefaultPrevented()) {
-            return;
-          }
-          // fallthrough
-        case 'ArrowDown':
-          // Stop propagation, unless it would already be handled by useKeyboard.
-          if (!('continuePropagation' in e)) {
-            e.stopPropagation();
-          }
-          e.preventDefault();
-          state.toggle('first');
-          break;
-        case 'ArrowUp':
-          if (!('continuePropagation' in e)) {
-            e.stopPropagation();
-          }
-          e.preventDefault();
-          state.toggle('last');
-          break;
-        default:
-          // Allow other keys.
-          if ('continuePropagation' in e) {
-            e.continuePropagation();
-          }
-      }
-    }
-  };
-
-  let stringFormatter = useLocalizedStringFormatter(intlMessages, '@react-aria/menu');
-  let {longPressProps} = useLongPress({
-    isDisabled: isDisabled || trigger !== 'longPress',
-    accessibilityDescription: stringFormatter.format('longPressMessage'),
-    onLongPressStart() {
-      state.close();
-    },
-    onLongPress() {
-      state.open('first');
-    }
-  });
-
-  let pressProps: PressProps =  {
-    preventFocusOnPress: true,
-    onPressStart(e) {
-      // For consistency with native, open the menu on mouse/key down, but touch up.
-      if (e.pointerType !== 'touch' && e.pointerType !== 'keyboard' && !isDisabled) {
-        // Ensure trigger has focus before opening the menu so it can be restored by FocusScope on close.
-        focusWithoutScrolling(e.target as FocusableElement);
-
-        // If opened with a screen reader, auto focus the first item.
-        // Otherwise, the menu itself will be focused.
-        state.open(e.pointerType === 'virtual' ? 'first' : null);
-      }
-    },
-    onPress(e) {
-      if (e.pointerType === 'touch' && !isDisabled) {
-        // Ensure trigger has focus before opening the menu so it can be restored by FocusScope on close.
-        focusWithoutScrolling(e.target as FocusableElement);
-
-        state.toggle();
-      }
-    }
-  };
-
-  // omit onPress from triggerProps since we override it above.
-  delete triggerProps.onPress;
-
-  return {
-    // @ts-ignore - TODO we pass out both DOMAttributes AND AriaButtonProps, but useButton will discard the longPress event handlers, it's only through PressResponder magic that this works for RSP and RAC. it does not work in aria examples
-    menuTriggerProps: {
-      ...triggerProps,
-      ...(trigger === 'press' ? pressProps : longPressProps),
-      id: menuTriggerId,
-      onKeyDown
-    },
-    menuProps: {
-      ...overlayProps,
-      'aria-labelledby': menuTriggerId,
-      autoFocus: state.focusStrategy || true,
-      onClose: state.close
-    }
-  };
-}