react-aria 3.48.0 → 3.50.0

package/dist/types/src/listbox/useListBoxSection.d.ts

@@ -17,6 +17,7 @@ export interface ListBoxSectionAria {
 /**
  * Provides the behavior and accessibility implementation for a section in a listbox.
  * See `useListBox` for more details about listboxes.
+ *
  * @param props - Props for the section.
  */
 export declare function useListBoxSection(props: AriaListBoxSectionProps): ListBoxSectionAria;

package/dist/types/src/listbox/useOption.d.ts

@@ -16,11 +16,13 @@ export interface OptionAria extends SelectableItemStates {
 export interface AriaOptionProps {
     /**
      * Whether the option is disabled.
+     *
      * @deprecated
      */
     isDisabled?: boolean;
     /**
      * Whether the option is selected.
+     *
      * @deprecated
      */
     isSelected?: boolean;
@@ -30,21 +32,25 @@ export interface AriaOptionProps {
     key: Key;
     /**
      * Whether selection should occur on press up instead of press down.
+     *
      * @deprecated
      */
     shouldSelectOnPressUp?: boolean;
     /**
      * Whether the option should be focused when the user hovers over it.
+     *
      * @deprecated
      */
     shouldFocusOnHover?: boolean;
     /**
      * Whether the option is contained in a virtual scrolling listbox.
+     *
      * @deprecated
      */
     isVirtualized?: boolean;
     /**
      * Whether the option should use virtual focus instead of being focused directly.
+     *
      * @deprecated
      */
     shouldUseVirtualFocus?: boolean;
@@ -52,6 +58,7 @@ export interface AriaOptionProps {
 /**
  * Provides the behavior and accessibility implementation for an option in a listbox.
  * See `useListBox` for more details about listboxes.
+ *
  * @param props - Props for the option.
  * @param state - State for the listbox, as returned by `useListState`.
  */

package/dist/types/src/menu/useMenu.d.ts

@@ -6,7 +6,7 @@ export interface MenuProps<T> extends CollectionBase<T>, MultipleSelection {
     /** Whether keyboard navigation is circular. */
     shouldFocusWrap?: boolean;
     /** Handler that is called when an item is selected. */
-    onAction?: (key: Key) => void;
+    onAction?: (key: Key, value: T) => void;
     /** Handler that is called when the menu should close after selecting an item. */
     onClose?: () => void;
 }
@@ -17,6 +17,7 @@ export interface AriaMenuProps<T> extends MenuProps<T>, DOMProps, AriaLabelingPr
      * Most experiences should not modify this option as it eliminates a keyboard user's ability to
      * easily clear selection. Only use if the escape key is being handled externally or should not
      * trigger selection clearing contextually.
+     *
      * @default 'clearSelection'
      */
     escapeKeyBehavior?: 'clearSelection' | 'none';
@@ -41,6 +42,7 @@ export interface AriaMenuOptions<T> extends Omit<AriaMenuProps<T>, 'children'>,
 /**
  * Provides the behavior and accessibility implementation for a menu component.
  * A menu displays a list of actions or options that a user can choose.
+ *
  * @param props - Props for the menu.
  * @param state - State for the menu, as returned by `useListState`.
  */

package/dist/types/src/menu/useMenuItem.d.ts

@@ -24,11 +24,13 @@ export interface MenuItemAria {
 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;
@@ -38,11 +40,13 @@ export interface AriaMenuItemProps extends DOMProps, PressEvents, HoverEvents, K
     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;
@@ -52,6 +56,7 @@ export interface AriaMenuItemProps extends DOMProps, PressEvents, HoverEvents, K
     isVirtualized?: boolean;
     /**
      * Handler that is called when the user activates the item.
+     *
      * @deprecated - pass to the menu instead.
      */
     onAction?: (key: Key) => void;
@@ -59,7 +64,10 @@ export interface AriaMenuItemProps extends DOMProps, PressEvents, HoverEvents, K
     '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. */
+    /**
+     * Identifies the menu item's popup element whose contents or presence is controlled by the menu
+     * item.
+     */
     'aria-controls'?: string;
     /** Identifies the element(s) that describe the menu item. */
     'aria-describedby'?: string;
@@ -69,6 +77,7 @@ export interface AriaMenuItemProps extends DOMProps, PressEvents, HoverEvents, K
 /**
  * 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`.
  */

package/dist/types/src/menu/useMenuSection.d.ts

@@ -17,6 +17,7 @@ export interface MenuSectionAria {
 /**
  * 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 declare function useMenuSection(props: AriaMenuSectionProps): MenuSectionAria;

package/dist/types/src/menu/useMenuTrigger.d.ts

@@ -18,6 +18,7 @@ export interface MenuTriggerAria<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.

package/dist/types/src/menu/useSafelyMouseToSubmenu.d.ts

@@ -10,8 +10,9 @@ interface SafelyMouseToSubmenuOptions {
     isDisabled?: boolean;
 }
 /**
- * Allows the user to move their pointer to the submenu without it closing when their mouse leaves the trigger element.
- * Prevents pointer events from going to the underlying menu if the user is moving their pointer towards the sub-menu.
+ * Allows the user to move their pointer to the submenu without it closing when their mouse leaves
+ * the trigger element. Prevents pointer events from going to the underlying menu if the user is
+ * moving their pointer towards the sub-menu.
  */
 export declare function useSafelyMouseToSubmenu(options: SafelyMouseToSubmenuOptions): void;
 export {};

package/dist/types/src/menu/useSubmenuTrigger.d.ts

@@ -6,7 +6,9 @@ import type { OverlayProps } from '../overlays/Overlay';
 import type { SubmenuTriggerState } from 'react-stately/useMenuTriggerState';
 export interface AriaSubmenuTriggerProps {
     /**
-     * An object representing the submenu trigger menu item. Contains all the relevant information that makes up the menu item.
+     * An object representing the submenu trigger menu item. Contains all the relevant information
+     * that makes up the menu item.
+     *
      * @deprecated
      */
     node?: Node<unknown>;
@@ -20,6 +22,7 @@ export interface AriaSubmenuTriggerProps {
     submenuRef: RefObject<HTMLElement | null>;
     /**
      * The delay time in milliseconds for the submenu to appear after hovering over the trigger.
+     *
      * @default 200
      */
     delay?: number;
@@ -43,7 +46,9 @@ export interface SubmenuTriggerAria<T> {
     popoverProps: Pick<AriaPopoverProps, 'isNonModal' | 'shouldCloseOnInteractOutside'> & Pick<OverlayProps, 'disableFocusManagement'>;
 }
 /**
- * Provides the behavior and accessibility implementation for a submenu trigger and its associated submenu.
+ * Provides the behavior and accessibility implementation for a submenu trigger and its associated
+ * submenu.
+ *
  * @param props - Props for the submenu trigger and refs attach to its submenu and parent menu.
  * @param state - State for the submenu trigger.
  * @param ref - Ref to the submenu trigger element.

package/dist/types/src/menu/utils.d.ts

@@ -2,7 +2,7 @@ import { Key } from '@react-types/shared';
 import { TreeState } from 'react-stately/useTreeState';
 interface MenuData {
     onClose?: () => void;
-    onAction?: (key: Key) => void;
+    onAction?: (key: Key, value: any) => void;
     shouldUseVirtualFocus?: boolean;
 }
 export declare const menuData: WeakMap<TreeState<unknown>, MenuData>;

package/dist/types/src/numberfield/useNumberField.d.ts

@@ -3,9 +3,15 @@ import { AriaLabelingProps, DOMAttributes, DOMProps, GroupDOMAttributes, TextInp
 import { InputHTMLAttributes, LabelHTMLAttributes, RefObject } from 'react';
 import { NumberFieldProps, NumberFieldState } from 'react-stately/useNumberFieldState';
 export interface AriaNumberFieldProps extends NumberFieldProps, DOMProps, AriaLabelingProps, TextInputDOMEvents {
-    /** A custom aria-label for the decrement button. If not provided, the localized string "Decrement" is used. */
+    /**
+     * A custom aria-label for the decrement button. If not provided, the localized string "Decrement"
+     * is used.
+     */
     decrementAriaLabel?: string;
-    /** A custom aria-label for the increment button. If not provided, the localized string "Increment" is used. */
+    /**
+     * A custom aria-label for the increment button. If not provided, the localized string "Increment"
+     * is used.
+     */
     incrementAriaLabel?: string;
     /**
      * Enables or disables changing the value with scroll.
@@ -29,7 +35,8 @@ export interface NumberFieldAria extends ValidationResult {
     errorMessageProps: DOMAttributes;
 }
 /**
- * Provides the behavior and accessibility implementation for a number field component.
- * Number fields allow users to enter a number, and increment or decrement the value using stepper buttons.
+ * Provides the behavior and accessibility implementation for a number field component. Number
+ * fields allow users to enter a number, and increment or decrement the value using stepper
+ * buttons.
  */
 export declare function useNumberField(props: AriaNumberFieldProps, state: NumberFieldState, inputRef: RefObject<HTMLInputElement | null>): NumberFieldAria;

package/dist/types/src/overlays/Overlay.d.ts

@@ -2,6 +2,7 @@ import React, { ReactNode } from 'react';
 export interface OverlayProps {
     /**
      * The container element in which the overlay portal will be placed.
+     *
      * @default document.body
      */
     portalContainer?: Element;

package/dist/types/src/overlays/PortalProvider.d.ts

@@ -2,7 +2,10 @@ import React, { JSX, ReactNode } from 'react';
 export interface PortalProviderProps {
     /** Should return the element where we should portal to. Can clear the context by passing null. */
     getContainer?: (() => HTMLElement | null) | null;
-    /** The content of the PortalProvider. Should contain all children that want to portal their overlays to the element returned by the provided `getContainer()`. */
+    /**
+     * The content of the PortalProvider. Should contain all children that want to portal their
+     * overlays to the element returned by the provided `getContainer()`.
+     */
     children: ReactNode;
 }
 export interface PortalProviderContextValue extends Omit<PortalProviderProps, 'children'> {

package/dist/types/src/overlays/ariaHideOutside.d.ts

@@ -6,6 +6,7 @@ interface AriaHideOutsideOptions {
  * Hides all elements in the DOM outside the given targets from screen readers using aria-hidden,
  * and returns a function to revert these changes. In addition, changes to the DOM are watched
  * and new elements outside the targets are automatically hidden.
+ *
  * @param targets - The elements that should remain visible.
  * @param root - Nothing will be hidden above this element.
  * @returns - A function to restore all hidden elements.

package/dist/types/src/overlays/calculatePosition.d.ts

@@ -33,6 +33,7 @@ interface PositionOpts {
     crossOffset: number;
     maxHeight?: number;
     arrowBoundaryOffset?: number;
+    targetRect?: Offset | null | undefined;
 }
 export interface PositionResult {
     position: Position;
@@ -47,7 +48,8 @@ export interface PositionResult {
 }
 export declare function calculatePositionInternal(placementInput: Placement, childOffset: Offset, overlaySize: Offset, scrollSize: Offset, margins: Position, padding: number, flip: boolean, boundaryDimensions: Dimensions, containerDimensions: Dimensions, containerOffsetWithBoundary: Offset, offset: number, crossOffset: number, isContainerPositioned: boolean, userSetMaxHeight: number | undefined, arrowSize: number, arrowBoundaryOffset: number, isContainerDescendentOfBoundary: boolean, visualViewport: VisualViewport | null): PositionResult;
 /**
- * Determines where to place the overlay with regards to the target and the position of an optional indicator.
+ * Determines where to place the overlay with regards to the target and the position of an optional
+ * indicator.
  */
 export declare function calculatePosition(opts: PositionOpts): PositionResult;
 export declare function getRect(node: Element, ignoreScale: boolean): {

package/dist/types/src/overlays/useModal.d.ts

@@ -4,12 +4,12 @@ export interface ModalProviderProps extends DOMAttributes {
     children: ReactNode;
 }
 /**
- * Each ModalProvider tracks how many modals are open in its subtree. On mount, the modals
- * trigger `addModal` to increment the count, and trigger `removeModal` on unmount to decrement it.
- * This is done recursively so that all parent providers are incremented and decremented.
- * If the modal count is greater than zero, we add `aria-hidden` to this provider to hide its
- * subtree from screen readers. This is done using React context in order to account for things
- * like portals, which can cause the React tree and the DOM tree to differ significantly in structure.
+ * Each ModalProvider tracks how many modals are open in its subtree. On mount, the modals trigger
+ * `addModal` to increment the count, and trigger `removeModal` on unmount to decrement it. This is
+ * done recursively so that all parent providers are incremented and decremented. If the modal count
+ * is greater than zero, we add `aria-hidden` to this provider to hide its subtree from screen
+ * readers. This is done using React context in order to account for things like portals, which can
+ * cause the React tree and the DOM tree to differ significantly in structure.
  */
 export declare function ModalProvider(props: ModalProviderProps): JSX.Element;
 export interface ModalProviderAria {
@@ -35,8 +35,9 @@ export declare function OverlayProvider(props: ModalProviderProps): JSX.Element;
 export interface OverlayContainerProps extends ModalProviderProps {
     /**
      * The container element in which the overlay portal will be placed.
-     * @default document.body
+     *
      * @deprecated - Use a parent UNSAFE_PortalProvider to set your portal container instead.
+     * @default document.body
      */
     portalContainer?: Element;
 }

package/dist/types/src/overlays/useModalOverlay.d.ts

@@ -4,11 +4,13 @@ import { OverlayTriggerState } from 'react-stately/useOverlayTriggerState';
 export interface AriaModalOverlayProps extends Pick<AriaOverlayProps, 'shouldCloseOnInteractOutside'> {
     /**
      * Whether to close the modal when the user interacts outside it.
+     *
      * @default false
      */
     isDismissable?: boolean;
     /**
      * Whether pressing the escape key to close the modal should be disabled.
+     *
      * @default false
      */
     isKeyboardDismissDisabled?: boolean;

package/dist/types/src/overlays/useOverlay.d.ts

@@ -6,6 +6,7 @@ export interface AriaOverlayProps {
     onClose?: () => void;
     /**
      * Whether to close the overlay when the user interacts outside it.
+     *
      * @default false
      */
     isDismissable?: boolean;
@@ -13,6 +14,7 @@ export interface AriaOverlayProps {
     shouldCloseOnBlur?: boolean;
     /**
      * Whether pressing the escape key to close the overlay should be disabled.
+     *
      * @default false
      */
     isKeyboardDismissDisabled?: boolean;

package/dist/types/src/overlays/useOverlayPosition.d.ts

@@ -6,30 +6,35 @@ export type PlacementAxis = Axis | 'center';
 export interface PositionProps {
     /**
      * The placement of the element with respect to its anchor element.
+     *
      * @default 'bottom'
      */
     placement?: Placement;
     /**
      * The placement padding that should be applied between the element and its
      * surrounding container.
+     *
      * @default 12
      */
     containerPadding?: number;
     /**
      * The additional offset applied along the main axis between the element and its
      * anchor element.
+     *
      * @default 0
      */
     offset?: number;
     /**
      * The additional offset applied along the cross axis between the element and its
      * anchor element.
+     *
      * @default 0
      */
     crossOffset?: number;
     /**
      * Whether the element should flip its orientation (e.g. top to bottom or left to right) when
      * there is insufficient room for it to render completely.
+     *
      * @default true
      */
     shouldFlip?: boolean;
@@ -39,11 +44,13 @@ export interface PositionProps {
 export interface AriaPositionProps extends PositionProps {
     /**
      * Cross size of the overlay arrow in pixels.
+     *
      * @default 0
      */
     arrowSize?: number;
     /**
      * Element that that serves as the positioning boundary.
+     *
      * @default document.body
      */
     boundaryElement?: Element;
@@ -61,11 +68,13 @@ export interface AriaPositionProps extends PositionProps {
     arrowRef?: RefObject<Element | null>;
     /**
      * A ref for the scrollable region within the overlay.
+     *
      * @default overlayRef
      */
     scrollRef?: RefObject<Element | null>;
     /**
      * Whether the overlay should update its position automatically.
+     *
      * @default true
      */
     shouldUpdatePosition?: boolean;
@@ -78,9 +87,18 @@ export interface AriaPositionProps extends PositionProps {
     maxHeight?: number;
     /**
      * The minimum distance the arrow's edge should be from the edge of the overlay element.
+     *
      * @default 0
      */
     arrowBoundaryOffset?: number;
+    /**
+     * Overrides the target element's bounding rectangle. Useful for positioning relative to
+     * a specific point such as the mouse cursor (e.g. context menus) or text selection.
+     *
+     * @default target.getBoundingClientRect()
+     * @param target - The target element.
+     */
+    getTargetRect?: (target: Element) => DOMRect | null | undefined;
 }
 export interface PositionAria {
     /** Props for the overlay container element. */

package/dist/types/src/progress/useProgressBar.d.ts

@@ -3,16 +3,19 @@ import { ReactNode } from 'react';
 export interface ProgressBarBaseProps {
     /**
      * The current value (controlled).
+     *
      * @default 0
      */
     value?: number;
     /**
      * The smallest value allowed for the input.
+     *
      * @default 0
      */
     minValue?: number;
     /**
      * The largest value allowed for the input.
+     *
      * @default 100
      */
     maxValue?: number;
@@ -20,7 +23,8 @@ export interface ProgressBarBaseProps {
     label?: ReactNode;
     /**
      * The display format of the value label.
-     * @default {style: 'percent'}
+     *
+     * @default { style: 'percent' }
      */
     formatOptions?: Intl.NumberFormatOptions;
     /** The content to display as the value's label (e.g. 1 of 4). */

package/dist/types/src/radio/useRadio.d.ts

@@ -1,4 +1,4 @@
-import { AriaLabelingProps, DOMProps, FocusableProps, PressEvents, RefObject } from '@react-types/shared';
+import { AriaLabelingProps, DOMAttributesWithRef, DOMProps, FocusableProps, PressEvents, RefObject } from '@react-types/shared';
 import { InputHTMLAttributes, LabelHTMLAttributes, ReactNode } from 'react';
 import { RadioGroupState } from 'react-stately/useRadioGroupState';
 export interface RadioProps extends FocusableProps {
@@ -24,6 +24,8 @@ export interface RadioAria {
     labelProps: LabelHTMLAttributes<HTMLLabelElement>;
     /** Props for the input element. */
     inputProps: InputHTMLAttributes<HTMLInputElement>;
+    /** Props for the checkbox description element, if any. */
+    descriptionProps: DOMAttributesWithRef<HTMLElement>;
     /** Whether the radio is disabled. */
     isDisabled: boolean;
     /** Whether the radio is currently selected. */
@@ -34,6 +36,7 @@ export interface RadioAria {
 /**
  * Provides the behavior and accessibility implementation for an individual
  * radio button in a radio group.
+ *
  * @param props - Props for the radio.
  * @param state - State for the radio group, as returned by `useRadioGroupState`.
  * @param ref - Ref to the HTML input element.

package/dist/types/src/radio/useRadioGroup.d.ts

@@ -15,6 +15,7 @@ export interface RadioGroupAria extends ValidationResult {
 /**
  * Provides the behavior and accessibility implementation for a radio group component.
  * Radio groups allow users to select a single item from a list of mutually exclusive options.
+ *
  * @param props - Props for the radio group.
  * @param state - State for the radio group, as returned by `useRadioGroupState`.
  */

package/dist/types/src/searchfield/useSearchField.d.ts

@@ -5,11 +5,15 @@ import { InputHTMLAttributes, LabelHTMLAttributes } from 'react';
 import { SearchFieldProps, SearchFieldState } from 'react-stately/useSearchFieldState';
 export interface AriaSearchFieldProps extends SearchFieldProps, Omit<AriaTextFieldProps, 'type'> {
     /**
-     * An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint).
+     * An enumerated attribute that defines what action label or icon to preset for the enter key on
+     * virtual keyboards. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint).
      */
     enterKeyHint?: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send';
     /**
-     * The type of input to render. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdeftype).
+     * The type of input to render. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdeftype).
+     *
      * @default 'search'
      */
     type?: 'text' | 'search' | 'url' | 'tel' | 'email' | 'password' | (string & {});
@@ -28,6 +32,7 @@ export interface SearchFieldAria extends ValidationResult {
 }
 /**
  * Provides the behavior and accessibility implementation for a search field.
+ *
  * @param props - Props for the search field.
  * @param state - State for the search field, as returned by `useSearchFieldState`.
  * @param inputRef - A ref to the input element.

package/dist/types/src/select/HiddenSelect.d.ts

@@ -3,7 +3,8 @@ import React, { JSX, ReactNode } from 'react';
 import { SelectionMode, SelectState } from 'react-stately/useSelectState';
 export interface AriaHiddenSelectProps {
     /**
-     * Describes the type of autocomplete functionality the input should provide if any. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).
+     * Describes the type of autocomplete functionality the input should provide if any. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).
      */
     autoComplete?: string;
     /** The text label for the select. */

package/dist/types/src/select/useSelect.d.ts

@@ -5,7 +5,8 @@ import { HiddenSelectProps } from './HiddenSelect';
 import { SelectionMode, SelectProps, SelectState } from 'react-stately/useSelectState';
 export interface AriaSelectProps<T, M extends SelectionMode = 'single'> extends SelectProps<T, M>, DOMProps, AriaLabelingProps, FocusableDOMProps {
     /**
-     * Describes the type of autocomplete functionality the input should provide if any. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).
+     * Describes the type of autocomplete functionality the input should provide if any. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).
      */
     autoComplete?: string;
     /**
@@ -53,6 +54,7 @@ export declare const selectData: WeakMap<SelectState<any, any>, SelectData>;
 /**
  * Provides the behavior and accessibility implementation for a select component.
  * A select displays a collapsible list of options and allows a user to select one of them.
+ *
  * @param props - Props for the select.
  * @param state - State for the select, as returned by `useListState`.
  */

package/dist/types/src/selection/ListKeyboardDelegate.d.ts

@@ -24,16 +24,29 @@ export declare class ListKeyboardDelegate<T> implements KeyboardDelegate {
     constructor(options: ListKeyboardDelegateOptions<T>);
     private isDisabled;
     private findNextNonDisabled;
-    getNextKey(key: Key): Key | null;
-    getPreviousKey(key: Key): Key | null;
+    getNextKey(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
+    getPreviousKey(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
     private findKey;
     private isSameRow;
     private isSameColumn;
-    getKeyBelow(key: Key): Key | null;
-    getKeyAbove(key: Key): Key | null;
+    private isReversed;
+    getKeyBelow(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
+    getKeyAbove(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
     private getNextColumn;
-    getKeyRightOf?(key: Key): Key | null;
-    getKeyLeftOf?(key: Key): Key | null;
+    getKeyRightOf?(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
+    getKeyLeftOf?(key: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
     getFirstKey(): Key | null;
     getLastKey(): Key | null;
     getKeyPageAbove(key: Key): Key | null;