feat: Add escapeKeyBehavior to GridList/ListBox/Menu/Table/Tree

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

@@ -53,7 +53,12 @@ export interface GridProps extends DOMProps, AriaLabelingProps {
   /** Handler that is called when a user performs an action on the row. */
   onRowAction?: (key: Key) => void,
   /** Handler that is called when a user performs an action on the cell. */
-  onCellAction?: (key: Key) => void
+  onCellAction?: (key: Key) => void,
+  /**
+   * Whether the grid allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean
 }
 
 export interface GridAria {
@@ -77,7 +82,8 @@ export function useGrid<T>(props: GridProps, state: GridState<T, GridCollection<
     scrollRef,
     getRowText,
     onRowAction,
-    onCellAction
+    onCellAction,
+    disallowClearAll = false
   } = props;
   let {selectionManager: manager} = state;
 
@@ -106,7 +112,8 @@ export function useGrid<T>(props: GridProps, state: GridState<T, GridCollection<
     keyboardDelegate: delegate,
     isVirtualized,
     scrollRef,
-    disallowTypeAhead
+    disallowTypeAhead,
+    disallowClearAll
   });
 
   let id = useId(props.id);

packages/@react-aria/gridlist/src/useGridList.ts

@@ -48,7 +48,12 @@ export interface AriaGridListProps<T> extends GridListProps<T>, DOMProps, AriaLa
    * via the left/right arrow keys or the tab key.
    * @default 'arrow'
    */
-  keyboardNavigationBehavior?: 'arrow' | 'tab'
+  keyboardNavigationBehavior?: 'arrow' | 'tab',
+  /**
+   * Whether the gridlist allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean
 }
 
 export interface AriaGridListOptions<T> extends Omit<AriaGridListProps<T>, 'children'> {
@@ -105,7 +110,8 @@ export function useGridList<T>(props: AriaGridListOptions<T>, state: ListState<T
     onAction,
     disallowTypeAhead,
     linkBehavior = 'action',
-    keyboardNavigationBehavior = 'arrow'
+    keyboardNavigationBehavior = 'arrow',
+    disallowClearAll = false
   } = props;
 
   if (!props['aria-label'] && !props['aria-labelledby']) {
@@ -124,7 +130,8 @@ export function useGridList<T>(props: AriaGridListOptions<T>, state: ListState<T
     shouldFocusWrap: props.shouldFocusWrap,
     linkBehavior,
     disallowTypeAhead,
-    autoFocus: props.autoFocus
+    autoFocus: props.autoFocus,
+    disallowClearAll
   });
 
   let id = useId(props.id);

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

@@ -54,6 +54,11 @@ export interface AriaSelectableCollectionOptions {
    * @default false
    */
   disallowSelectAll?: boolean,
+  /**
+   * Whether the collection allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean,
   /**
    * Whether selection should occur automatically on focus.
    * @default false
@@ -108,6 +113,7 @@ export function useSelectableCollection(options: AriaSelectableCollectionOptions
     shouldFocusWrap = false,
     disallowEmptySelection = false,
     disallowSelectAll = false,
+    disallowClearAll = false,
     selectOnFocus = manager.selectionBehavior === 'replace',
     disallowTypeAhead = false,
     shouldUseVirtualFocus,
@@ -279,7 +285,7 @@ export function useSelectableCollection(options: AriaSelectableCollectionOptions
         }
         break;
       case 'Escape':
-        if (!disallowEmptySelection && manager.selectedKeys.size !== 0) {
+        if (!disallowClearAll && !disallowEmptySelection && manager.selectedKeys.size !== 0) {
           e.stopPropagation();
           e.preventDefault();
           manager.clearSelection();

packages/@react-types/listbox/src/index.d.ts

@@ -32,7 +32,12 @@ export interface AriaListBoxProps<T> extends AriaListBoxPropsBase<T> {
    * Handler that is called when a user performs an action on an item. The exact user event depends on
    * the collection's `selectionBehavior` prop and the interaction modality.
    */
-  onAction?: (key: Key) => void
+  onAction?: (key: Key) => void,
+  /**
+   * Whether the listbox allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean
 }
 
 export interface SpectrumListBoxProps<T> extends AriaListBoxPropsBase<T>, AsyncLoadable, StyleProps {

packages/@react-types/menu/src/index.d.ts

@@ -62,7 +62,13 @@ export interface MenuProps<T> extends CollectionBase<T>, MultipleSelection {
   onClose?: () => void
 }
 
-export interface AriaMenuProps<T> extends MenuProps<T>, DOMProps, AriaLabelingProps {}
+export interface AriaMenuProps<T> extends MenuProps<T>, DOMProps, AriaLabelingProps {
+  /**
+   * Whether the menu allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean
+}
 export interface SpectrumMenuProps<T> extends AriaMenuProps<T>, StyleProps {}
 
 export interface SpectrumActionMenuProps<T> extends CollectionBase<T>, Omit<SpectrumMenuTriggerProps, 'children'>, StyleProps, DOMProps, AriaLabelingProps {

packages/@react-types/table/src/index.d.ts

@@ -29,7 +29,12 @@ export interface TableProps<T> extends MultipleSelection, Sortable {
   /** The elements that make up the table. Includes the TableHeader, TableBody, Columns, and Rows. */
   children: [ReactElement<TableHeaderProps<T>>, ReactElement<TableBodyProps<T>>],
   /** A list of row keys to disable. */
-  disabledKeys?: Iterable<Key>
+  disabledKeys?: Iterable<Key>,
+  /**
+   * Whether the table allows the user to clear all selected items via Escape.
+   * @default false
+   */
+  disallowClearAll?: boolean
 }
 
 /**