Feat: Add support for orientation to KeyboardDelegate interface

Author: nwidynski

packages/@react-aria/combobox/src/useComboBox.ts

@@ -107,7 +107,8 @@ export function useComboBox<T>(props: AriaComboBoxOptions<T>, state: ComboBoxSta
       collection,
       disabledKeys,
       ref: listBoxRef,
-      layoutDelegate
+      layoutDelegate,
+      orientation: 'vertical'
     })
   ), [keyboardDelegate, layoutDelegate, collection, disabledKeys, listBoxRef]);
 
@@ -380,6 +381,7 @@ export function useComboBox<T>(props: AriaComboBoxOptions<T>, state: ComboBoxSta
       shouldUseVirtualFocus: true,
       shouldSelectOnPressUp: true,
       shouldFocusOnHover: true,
+      orientation: 'vertical' as const,
       linkBehavior: 'selection' as const
     }),
     descriptionProps,

packages/@react-aria/grid/src/GridKeyboardDelegate.ts

@@ -50,6 +50,10 @@ export class GridKeyboardDelegate<T, C extends GridCollection<T>> implements Key
     this.focusMode = options.focusMode ?? 'row';
   }
 
+  getOrientation(): Orientation | null {
+    return this.layoutDelegate.getOrientation?.() || 'vertical';
+  }
+
   protected isCell(node: Node<T>): boolean {
     return node.type === 'cell';
   }

packages/@react-aria/listbox/src/useListBox.ts

@@ -11,7 +11,7 @@
  */
 
 import {AriaListBoxProps} from '@react-types/listbox';
-import {DOMAttributes, KeyboardDelegate, LayoutDelegate, RefObject} from '@react-types/shared';
+import {DOMAttributes, KeyboardDelegate, LayoutDelegate, Orientation, RefObject} from '@react-types/shared';
 import {filterDOMProps, mergeProps, useId} from '@react-aria/utils';
 import {listData} from './utils';
 import {ListState} from '@react-stately/list';
@@ -55,7 +55,12 @@ export interface AriaListBoxOptions<T> extends Omit<AriaListBoxProps<T>, 'childr
    * - 'override': links override all other interactions (link items are not selectable).
    * @default 'override'
    */
-  linkBehavior?: 'action' | 'selection' | 'override'
+  linkBehavior?: 'action' | 'selection' | 'override',
+
+  /**
+   * The orientation of the listbox.
+   */
+  orientation?: Orientation
 }
 
 /**
@@ -68,6 +73,7 @@ export function useListBox<T>(props: AriaListBoxOptions<T>, state: ListState<T>,
   let domProps = filterDOMProps(props, {labelable: true});
   // Use props instead of state here. We don't want this to change due to long press.
   let selectionBehavior = props.selectionBehavior || 'toggle';
+  let orientation = props.orientation || props.keyboardDelegate?.getOrientation?.();
   let linkBehavior = props.linkBehavior || (selectionBehavior === 'replace' ? 'action' : 'override');
   if (selectionBehavior === 'toggle' && linkBehavior === 'action') {
     // linkBehavior="action" does not work with selectionBehavior="toggle" because there is no way
@@ -117,6 +123,7 @@ export function useListBox<T>(props: AriaListBoxOptions<T>, state: ListState<T>,
       'aria-multiselectable': 'true'
     } : {}, {
       role: 'listbox',
+      'aria-orientation': orientation === 'horizontal' ? orientation : undefined,
       ...mergeProps(fieldProps, listProps)
     })
   };

packages/@react-aria/menu/src/useMenu.ts

@@ -62,6 +62,7 @@ export function useMenu<T>(props: AriaMenuOptions<T>, state: TreeState<T>, ref:
     collection: state.collection,
     disabledKeys: state.disabledKeys,
     shouldFocusWrap,
+    orientation: 'vertical',
     linkBehavior: 'override'
   });
 

packages/@react-aria/selection/src/DOMLayoutDelegate.ts

@@ -15,15 +15,35 @@ import {Key, LayoutDelegate, Orientation, Rect, RefObject, Size} from '@react-ty
 
 export class DOMLayoutDelegate implements LayoutDelegate {
   private ref: RefObject<HTMLElement | null>;
-  private orientation: Orientation;
+  private orientation?: Orientation;
 
   constructor(ref: RefObject<HTMLElement | null>, orientation?: Orientation) {
     this.ref = ref;
-    this.orientation = orientation ?? 'vertical';
+    this.orientation = orientation;
   }
 
-  getOrientation(): Orientation {
-    return this.orientation;
+  getOrientation(): Orientation | null {
+    let container = this.ref.current;
+    if (this.orientation) {
+      return this.orientation;
+    }
+
+    // https://w3c.github.io/aria/#aria-orientation
+    switch (container?.role) {
+      case 'menubar':
+      case 'slider':
+      case 'separator':
+      case 'tablist':
+      case 'toolbar':
+        return 'horizontal';
+      case 'listbox':
+      case 'menu':
+      case 'scrollbar':
+      case 'tree':
+        return 'vertical';
+      default:
+        return null;
+    }
   }
 
   getItemRect(key: Key): Rect | null {

packages/@react-aria/selection/src/ListKeyboardDelegate.ts

@@ -47,7 +47,7 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
       this.collator = opts.collator;
       this.disabledKeys = opts.disabledKeys || new Set();
       this.disabledBehavior = opts.disabledBehavior || 'all';
-      this.orientation = opts.orientation || 'vertical';
+      this.orientation = opts.orientation;
       this.direction = opts.direction;
       this.layout = opts.layout || 'stack';
       this.layoutDelegate = opts.layoutDelegate || new DOMLayoutDelegate(opts.ref, this.orientation);
@@ -57,17 +57,31 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
       this.ref = args[2];
       this.collator = args[3];
       this.layout = 'stack';
-      this.orientation = 'vertical';
       this.disabledBehavior = 'all';
-      this.layoutDelegate = new DOMLayoutDelegate(this.ref, this.orientation);
+      this.layoutDelegate = new DOMLayoutDelegate(this.ref);
     }
 
     // If this is a vertical stack, remove the left/right methods completely
-    // so they aren't called by useDroppableCollection.
-    if (this.layout === 'stack' && this.orientation === 'vertical') {
-      this.getKeyLeftOf = undefined;
-      this.getKeyRightOf = undefined;
-    }
+    // so they aren't called by useDroppableCollection or useAutocomplete.
+    let getKeyRightOf = this.getKeyRightOf;
+    let getKeyLeftOf = this.getKeyLeftOf;
+
+    Object.defineProperty(this, 'getKeyRightOf', {
+      get() { return this.layout === 'stack' && this.getOrientation() === 'vertical' ? undefined : getKeyRightOf; },
+      configurable: true,
+      enumerable: false
+    });
+
+    Object.defineProperty(this, 'getKeyLeftOf', {
+      get() { return this.layout === 'stack' && this.getOrientation() === 'vertical' ? undefined : getKeyLeftOf; },
+      configurable: true,
+      enumerable: false
+    });
+  }
+
+  getOrientation(): Orientation {
+    // TODO: Should we log a warning if keyboard and layout delegate mismatch in orientation?
+    return this.orientation || this.layoutDelegate.getOrientation?.() || 'vertical';
   }
 
   private isDisabled(item: Node<unknown>) {
@@ -133,15 +147,15 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
   }
 
   getKeyBelow(key: Key): Key | null {
-    if (this.layout === 'grid' && this.orientation === 'vertical') {
+    if (this.layout === 'grid' && this.getOrientation() === 'vertical') {
       return this.findKey(key, (key) => this.getNextKey(key), this.isSameRow);
     } else {
       return this.getNextKey(key);
     }
   }
 
   getKeyAbove(key: Key): Key | null {
-    if (this.layout === 'grid' && this.orientation === 'vertical') {
+    if (this.layout === 'grid' && this.getOrientation() === 'vertical') {
       return this.findKey(key, (key) => this.getPreviousKey(key), this.isSameRow);
     } else {
       return this.getPreviousKey(key);
@@ -162,12 +176,12 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
     }
 
     if (this.layout === 'grid') {
-      if (this.orientation === 'vertical') {
+      if (this.getOrientation() === 'vertical') {
         return this.getNextColumn(key, this.direction === 'rtl');
       } else {
         return this.findKey(key, (key) => this.getNextColumn(key, this.direction === 'rtl'), this.isSameColumn);
       }
-    } else if (this.orientation === 'horizontal') {
+    } else if (this.getOrientation() === 'horizontal') {
       return this.getNextColumn(key, this.direction === 'rtl');
     }
 
@@ -182,12 +196,12 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
     }
 
     if (this.layout === 'grid') {
-      if (this.orientation === 'vertical') {
+      if (this.getOrientation() === 'vertical') {
         return this.getNextColumn(key, this.direction === 'ltr');
       } else {
         return this.findKey(key, (key) => this.getNextColumn(key, this.direction === 'ltr'), this.isSameColumn);
       }
-    } else if (this.orientation === 'horizontal') {
+    } else if (this.getOrientation() === 'horizontal') {
       return this.getNextColumn(key, this.direction === 'ltr');
     }
 
@@ -216,7 +230,7 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
     }
 
     let nextKey: Key | null = key;
-    if (this.orientation === 'horizontal') {
+    if (this.getOrientation() === 'horizontal') {
       let pageX = Math.max(0, itemRect.x + itemRect.width - this.layoutDelegate.getVisibleRect().width);
 
       while (itemRect && itemRect.x > pageX && nextKey != null) {
@@ -247,7 +261,7 @@ export class ListKeyboardDelegate<T> implements KeyboardDelegate {
     }
 
     let nextKey: Key | null = key;
-    if (this.orientation === 'horizontal') {
+    if (this.getOrientation() === 'horizontal') {
       let pageX = Math.min(this.layoutDelegate.getContentSize().width, itemRect.y - itemRect.width + this.layoutDelegate.getVisibleRect().width);
 
       while (itemRect && itemRect.x < pageX && nextKey != null) {

packages/@react-aria/selection/src/useSelectableList.ts

@@ -11,7 +11,7 @@
  */
 
 import {AriaSelectableCollectionOptions, useSelectableCollection} from './useSelectableCollection';
-import {Collection, DOMAttributes, Key, KeyboardDelegate, LayoutDelegate, Node} from '@react-types/shared';
+import {Collection, DOMAttributes, Key, KeyboardDelegate, LayoutDelegate, Node, Orientation} from '@react-types/shared';
 import {ListKeyboardDelegate} from './ListKeyboardDelegate';
 import {useCollator} from '@react-aria/i18n';
 import {useMemo} from 'react';
@@ -34,7 +34,12 @@ export interface AriaSelectableListOptions extends Omit<AriaSelectableCollection
   /**
    * The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.
    */
-  disabledKeys: Set<Key>
+  disabledKeys: Set<Key>,
+  /**
+   * The primary orientation of the items. Usually this is the
+   * direction that the collection scrolls.
+   */
+  orientation?: Orientation
 }
 
 export interface SelectableListAria {
@@ -54,7 +59,8 @@ export function useSelectableList(props: AriaSelectableListOptions): SelectableL
     disabledKeys,
     ref,
     keyboardDelegate,
-    layoutDelegate
+    layoutDelegate,
+    orientation
   } = props;
 
   // By default, a KeyboardDelegate is provided which uses the DOM to query layout information (e.g. for page up/page down).
@@ -68,9 +74,10 @@ export function useSelectableList(props: AriaSelectableListOptions): SelectableL
       disabledBehavior,
       ref,
       collator,
-      layoutDelegate
+      layoutDelegate,
+      orientation
     })
-  ), [keyboardDelegate, layoutDelegate, collection, disabledKeys, ref, collator, disabledBehavior]);
+  ), [keyboardDelegate, layoutDelegate, collection, disabledKeys, ref, collator, disabledBehavior, orientation]);
 
   let {collectionProps} = useSelectableCollection({
     ...props,

packages/@react-aria/tabs/src/TabsKeyboardDelegate.ts

@@ -16,13 +16,17 @@ export class TabsKeyboardDelegate<T> implements KeyboardDelegate {
   private collection: Collection<Node<T>>;
   private flipDirection: boolean;
   private disabledKeys: Set<Key>;
-  private tabDirection: boolean;
+  private orientation: Orientation;
 
   constructor(collection: Collection<Node<T>>, direction: Direction, orientation: Orientation, disabledKeys: Set<Key> = new Set()) {
     this.collection = collection;
     this.flipDirection = direction === 'rtl' && orientation === 'horizontal';
     this.disabledKeys = disabledKeys;
-    this.tabDirection = orientation === 'horizontal';
+    this.orientation = orientation;
+  }
+
+  getOrientation(): Orientation {
+    return this.orientation;
   }
 
   getKeyLeftOf(key: Key): Key | null {
@@ -61,14 +65,14 @@ export class TabsKeyboardDelegate<T> implements KeyboardDelegate {
   }
 
   getKeyAbove(key: Key): Key | null {
-    if (this.tabDirection) {
+    if (this.getOrientation() === 'horizontal') {
       return null;
     }
     return this.getPreviousKey(key);
   }
 
   getKeyBelow(key: Key): Key | null {
-    if (this.tabDirection) {
+    if (this.getOrientation() === 'horizontal') {
       return null;
     }
     return this.getNextKey(key);

packages/@react-aria/tabs/src/useTabList.ts

@@ -68,7 +68,7 @@ export function useTabList<T>(props: AriaTabListOptions<T>, state: TabListState<
     tabListProps: {
       ...mergeProps(collectionProps, tabListLabelProps),
       role: 'tablist',
-      'aria-orientation': orientation,
+      'aria-orientation': orientation === 'vertical' ? orientation : undefined,
       tabIndex: undefined
     }
   };