react-aria 3.48.0 → 3.49.0

package/dist/types/src/calendar/useCalendarMonthPicker.d.ts

@@ -0,0 +1,22 @@
+import { CalendarDate } from '@internationalized/date';
+import { CalendarSelectionMode, CalendarState } from 'react-stately/useCalendarState';
+import { Key } from '@react-types/shared';
+import { RangeCalendarState } from 'react-stately/useRangeCalendarState';
+export interface CalendarMonthPickerProps {
+    /**
+     * The format of the month.
+     */
+    format?: 'numeric' | '2-digit' | 'long' | 'short' | 'narrow';
+}
+export interface CalendarMonthPickerAria {
+    'aria-label': string;
+    value: Key;
+    onChange: (key: Key | null) => void;
+    items: CalendarMonthPickerItem[];
+}
+export interface CalendarMonthPickerItem {
+    id: number;
+    date: CalendarDate;
+    formatted: string;
+}
+export declare function useCalendarMonthPicker(props: CalendarMonthPickerProps, state: CalendarState<CalendarSelectionMode> | RangeCalendarState): CalendarMonthPickerAria;

package/dist/types/src/calendar/useCalendarYearPicker.d.ts

@@ -0,0 +1,32 @@
+import { CalendarDate } from '@internationalized/date';
+import { CalendarSelectionMode, CalendarState } from 'react-stately/useCalendarState';
+import { Key } from '@react-types/shared';
+import { RangeCalendarState } from 'react-stately/useRangeCalendarState';
+export interface CalendarYearPickerFormatOptions {
+    year?: 'numeric' | '2-digit';
+    era?: 'long' | 'short' | 'narrow';
+}
+export interface CalendarYearPickerProps {
+    /**
+     * The number of years to display.
+     *
+     * @default 20
+     */
+    visibleYears?: number;
+    /**
+     * The format to display.
+     */
+    format?: CalendarYearPickerFormatOptions;
+}
+export interface CalendarYearPickerAria {
+    'aria-label': string;
+    value: Key;
+    onChange: (key: Key | null) => void;
+    items: CalendarYearPickerItem[];
+}
+export interface CalendarYearPickerItem {
+    id: number;
+    date: CalendarDate;
+    formatted: string;
+}
+export declare function useCalendarYearPicker(props: CalendarYearPickerProps, state: CalendarState<CalendarSelectionMode> | RangeCalendarState): CalendarYearPickerAria;

package/dist/types/src/calendar/useRangeCalendar.d.ts

@@ -4,19 +4,19 @@ import { DateValue, RangeCalendarState } from 'react-stately/useRangeCalendarSta
 import { RangeCalendarProps } from 'react-stately/useRangeCalendarState';
 export interface AriaRangeCalendarProps<T extends DateValue> extends RangeCalendarProps<T>, DOMProps, AriaLabelingProps {
     /**
-     * Controls the behavior when a pointer is released outside the calendar or a blur occurs mid selection:
+     * Controls the behavior when a pointer is released outside the calendar or a blur occurs mid
+     * selection:
      *
      * - `clear`: clear the currently selected range of dates.
-     *
      * - `reset`: reset the selection to the previously selected range of dates.
-     *
      * - `select`: select the currently hovered range of dates.
+     *
      * @default 'select'
      */
     commitBehavior?: 'clear' | 'reset' | 'select';
 }
 /**
- * Provides the behavior and accessibility implementation for a range calendar component.
- * A range calendar displays one or more date grids and allows users to select a contiguous range of dates.
+ * Provides the behavior and accessibility implementation for a range calendar component. A range
+ * calendar displays one or more date grids and allows users to select a contiguous range of dates.
  */
 export declare function useRangeCalendar<T extends DateValue>(props: AriaRangeCalendarProps<T>, state: RangeCalendarState, ref: RefObject<FocusableElement | null>): CalendarAria;

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

@@ -1,5 +1,5 @@
 import { CalendarDate } from '@internationalized/date';
-import { CalendarState } from 'react-stately/useCalendarState';
+import { CalendarSelectionMode, CalendarState } from 'react-stately/useCalendarState';
 import { RangeCalendarState } from 'react-stately/useRangeCalendarState';
 interface HookData {
     ariaLabel?: string;
@@ -7,8 +7,8 @@ interface HookData {
     errorMessageId: string;
     selectedDateDescription: string;
 }
-export declare const hookData: WeakMap<CalendarState | RangeCalendarState, HookData>;
+export declare const hookData: WeakMap<CalendarState<CalendarSelectionMode> | RangeCalendarState, HookData>;
 export declare function getEraFormat(date: CalendarDate | undefined): 'short' | undefined;
-export declare function useSelectedDateDescription(state: CalendarState | RangeCalendarState): string;
+export declare function useSelectedDateDescription(state: CalendarState<'single' | 'multiple'> | RangeCalendarState): string;
 export declare function useVisibleRangeDescription(startDate: CalendarDate, endDate: CalendarDate, timeZone: string, isAria: boolean): string;
 export {};

package/dist/types/src/checkbox/useCheckbox.d.ts

@@ -1,5 +1,5 @@
 import { AriaToggleProps } from '../toggle/useToggle';
-import { InputDOMProps, RefObject, ValidationResult } from '@react-types/shared';
+import { DOMAttributesWithRef, InputDOMProps, RefObject, ValidationResult } from '@react-types/shared';
 import { InputHTMLAttributes, LabelHTMLAttributes } from 'react';
 import { ToggleProps, ToggleState } from 'react-stately/useToggleState';
 export interface CheckboxProps extends ToggleProps {
@@ -16,6 +16,10 @@ export interface CheckboxAria extends ValidationResult {
     labelProps: LabelHTMLAttributes<HTMLLabelElement>;
     /** Props for the input element. */
     inputProps: InputHTMLAttributes<HTMLInputElement>;
+    /** Props for the checkbox description element, if any. */
+    descriptionProps: DOMAttributesWithRef<HTMLElement>;
+    /** Props for the checkbox error message element, if any. */
+    errorMessageProps: DOMAttributesWithRef<HTMLElement>;
     /** Whether the checkbox is selected. */
     isSelected: boolean;
     /** Whether the checkbox is in a pressed state. */
@@ -29,6 +33,7 @@ export interface CheckboxAria extends ValidationResult {
  * Provides the behavior and accessibility implementation for a checkbox component.
  * Checkboxes allow users to select multiple items from a list of individual items, or
  * to mark one individual item as selected.
+ *
  * @param props - Props for the checkbox.
  * @param state - State for the checkbox, as returned by `useToggleState`.
  * @param inputRef - A ref for the HTML input element.

package/dist/types/src/checkbox/useCheckboxGroup.d.ts

@@ -15,6 +15,7 @@ export interface CheckboxGroupAria extends ValidationResult {
 /**
  * Provides the behavior and accessibility implementation for a checkbox group component.
  * Checkbox groups allow users to select multiple items from a list of options.
+ *
  * @param props - Props for the checkbox group.
  * @param state - State for the checkbox group, as returned by `useCheckboxGroupState`.
  */

package/dist/types/src/checkbox/useCheckboxGroupItem.d.ts

@@ -5,8 +5,9 @@ export interface AriaCheckboxGroupItemProps extends Omit<AriaCheckboxProps, 'isS
     value: string;
 }
 /**
- * Provides the behavior and accessibility implementation for a checkbox component contained within a checkbox group.
- * Checkbox groups allow users to select multiple items from a list of options.
+ * Provides the behavior and accessibility implementation for a checkbox component contained within
+ * a checkbox group. Checkbox groups allow users to select multiple items from a list of options.
+ *
  * @param props - Props for the checkbox.
  * @param state - State for the checkbox, as returned by `useCheckboxGroupState`.
  * @param inputRef - A ref for the HTML input element.

package/dist/types/src/collections/CollectionBuilder.d.ts

@@ -2,25 +2,26 @@ import { BaseCollection, CollectionNode } from './BaseCollection';
 import { CachedChildrenOptions } from './useCachedChildren';
 import { Key, Node } from '@react-types/shared';
 import React, { ForwardedRef, JSX, ReactElement, ReactNode } from 'react';
-export interface CollectionBuilderProps<C extends BaseCollection<object>> {
+export interface CollectionBuilderProps<C extends BaseCollection<any>> {
     content: ReactNode;
     children: (collection: C) => ReactNode;
     createCollection?: () => C;
 }
 /**
- * Builds a `Collection` from the children provided to the `content` prop, and passes it to the child render prop function.
+ * Builds a `Collection` from the children provided to the `content` prop, and passes it to the
+ * child render prop function.
  */
-export declare function CollectionBuilder<C extends BaseCollection<object>>(props: CollectionBuilderProps<C>): ReactElement;
+export declare function CollectionBuilder<C extends BaseCollection<any>>(props: CollectionBuilderProps<C>): ReactElement;
 export type CollectionNodeClass<T> = {
     new (key: Key): CollectionNode<T>;
     readonly type: string;
 };
-export declare function createLeafComponent<T extends object, P extends object, E extends Element>(CollectionNodeClass: CollectionNodeClass<any> | string, render: (props: P, ref: ForwardedRef<E>) => ReactElement | null): (props: P & React.RefAttributes<E>) => ReactElement | null;
-export declare function createLeafComponent<T extends object, P extends object, E extends Element>(CollectionNodeClass: CollectionNodeClass<any> | string, render: (props: P, ref: ForwardedRef<E>, node: Node<T>) => ReactElement | null): (props: P & React.RefAttributes<E>) => ReactElement | null;
-export declare function createBranchComponent<T extends object, P extends {
+export declare function createLeafComponent<T, P extends object, E extends Element>(CollectionNodeClass: CollectionNodeClass<any> | string, render: (props: P, ref: ForwardedRef<E>) => ReactElement | null): (props: P & React.RefAttributes<E>) => ReactElement | null;
+export declare function createLeafComponent<T, P extends object, E extends Element>(CollectionNodeClass: CollectionNodeClass<any> | string, render: (props: P, ref: ForwardedRef<E>, node: Node<T>) => ReactElement | null): (props: P & React.RefAttributes<E>) => ReactElement | null;
+export declare function createBranchComponent<T, P extends {
     children?: any;
 }, E extends Element>(CollectionNodeClass: CollectionNodeClass<any> | string, render: (props: P, ref: ForwardedRef<E>, node: Node<T>) => ReactElement | null, useChildren?: (props: P) => ReactNode): (props: P & React.RefAttributes<E>) => ReactElement | null;
 export interface CollectionProps<T> extends CachedChildrenOptions<T> {
 }
 /** A Collection renders a list of items, automatically managing caching and keys. */
-export declare function Collection<T extends object>(props: CollectionProps<T>): JSX.Element;
+export declare function Collection<T>(props: CollectionProps<T>): JSX.Element;

package/dist/types/src/collections/useCachedChildren.d.ts

@@ -16,4 +16,4 @@ export interface CachedChildrenOptions<T> {
  * Maps over a list of items and renders React elements for them. Each rendered item is
  * cached based on object identity, and React keys are generated from the `key` or `id` property.
  */
-export declare function useCachedChildren<T extends object>(props: CachedChildrenOptions<T>): ReactNode;
+export declare function useCachedChildren<T>(props: CachedChildrenOptions<T>): ReactNode;

package/dist/types/src/color/useColorArea.d.ts

@@ -3,11 +3,13 @@ import { ColorAreaProps, ColorAreaState } from 'react-stately/useColorAreaState'
 import { InputHTMLAttributes } from 'react';
 export interface AriaColorAreaProps extends ColorAreaProps, DOMProps, AriaLabelingProps {
     /**
-     * The name of the x channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
+     * The name of the x channel input element, used when submitting an HTML form. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
      */
     xName?: string;
     /**
-     * The name of the y channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
+     * The name of the y channel input element, used when submitting an HTML form. See
+     * [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
      */
     yName?: string;
     /**
@@ -36,7 +38,8 @@ export interface AriaColorAreaOptions extends AriaColorAreaProps {
     containerRef: RefObject<Element | null>;
 }
 /**
- * Provides the behavior and accessibility implementation for a color area component.
- * Color area allows users to adjust two channels of an RGB, HSL or HSB color value against a two-dimensional gradient background.
+ * Provides the behavior and accessibility implementation for a color area component. Color area
+ * allows users to adjust two channels of an RGB, HSL or HSB color value against a two-dimensional
+ * gradient background.
  */
 export declare function useColorArea(props: AriaColorAreaOptions, state: ColorAreaState): ColorAreaAria;

package/dist/types/src/color/useColorChannelField.d.ts

@@ -6,7 +6,7 @@ export interface AriaColorChannelFieldProps extends ColorChannelFieldProps, Aria
 export interface ColorChannelFieldAria extends NumberFieldAria {
 }
 /**
- * Provides the behavior and accessibility implementation for a color channel field, allowing users to edit the
- * value of an individual color channel.
+ * Provides the behavior and accessibility implementation for a color channel field, allowing users
+ * to edit the value of an individual color channel.
  */
 export declare function useColorChannelField(props: AriaColorChannelFieldProps, state: ColorChannelFieldState, inputRef: RefObject<HTMLInputElement | null>): ColorChannelFieldAria;

package/dist/types/src/combobox/useComboBox.d.ts

@@ -14,7 +14,7 @@ export interface AriaComboBoxOptions<T, M extends SelectionMode = 'single'> exte
     popoverRef: RefObject<Element | null>;
     /** The ref for the list box. */
     listBoxRef: RefObject<HTMLElement | null>;
-    /** The ref for the optional list box popup trigger button.  */
+    /** The ref for the optional list box popup trigger button. */
     buttonRef?: RefObject<Element | null>;
     /** An optional keyboard delegate implementation, to override the default. */
     keyboardDelegate?: KeyboardDelegate;
@@ -42,8 +42,10 @@ export interface ComboBoxAria<T> extends ValidationResult {
     errorMessageProps: DOMAttributes;
 }
 /**
- * Provides the behavior and accessibility implementation for a combo box component.
- * A combo box combines a text input with a listbox, allowing users to filter a list of options to items matching a query.
+ * Provides the behavior and accessibility implementation for a combo box component. A combo box
+ * combines a text input with a listbox, allowing users to filter a list of options to items
+ * matching a query.
+ *
  * @param props - Props for the combo box.
  * @param state - State for the select, as returned by `useComboBoxState`.
  */

package/dist/types/src/datepicker/useDateField.d.ts

@@ -5,7 +5,8 @@ import { InputHTMLAttributes } from 'react';
 import { TimeFieldState, TimePickerProps, TimeValue } from 'react-stately/useTimeFieldState';
 export interface AriaDateFieldProps<T extends DateValue> extends DateFieldProps<T>, AriaLabelingProps, DOMProps, InputDOMProps {
     /**
-     * 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;
 }

package/dist/types/src/datepicker/useDatePicker.d.ts

@@ -5,7 +5,8 @@ import { CalendarProps } from 'react-stately/useCalendarState';
 import { DatePickerProps, DatePickerState, DateValue } from 'react-stately/useDatePickerState';
 export interface AriaDatePickerProps<T extends DateValue> extends DatePickerProps<T>, AriaLabelingProps, InputDOMProps, DOMProps, InputDOMProps {
     /**
-     * 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;
 }
@@ -28,7 +29,8 @@ export interface DatePickerAria extends ValidationResult {
     calendarProps: CalendarProps<DateValue>;
 }
 /**
- * Provides the behavior and accessibility implementation for a date picker component.
- * A date picker combines a DateField and a Calendar popover to allow users to enter or select a date and time value.
+ * Provides the behavior and accessibility implementation for a date picker component. A date picker
+ * combines a DateField and a Calendar popover to allow users to enter or select a date and time
+ * value.
  */
 export declare function useDatePicker<T extends DateValue>(props: AriaDatePickerProps<T>, state: DatePickerState, ref: RefObject<Element | null>): DatePickerAria;

package/dist/types/src/dialog/useDialog.d.ts

@@ -2,6 +2,7 @@ import { AriaLabelingProps, DOMAttributes, DOMProps, FocusableElement, RefObject
 export interface AriaDialogProps extends DOMProps, AriaLabelingProps {
     /**
      * The accessibility role for the dialog.
+     *
      * @default 'dialog'
      */
     role?: 'dialog' | 'alertdialog';

package/dist/types/src/disclosure/useDisclosure.d.ts

@@ -19,6 +19,7 @@ export interface DisclosureAria {
 }
 /**
  * Provides the behavior and accessibility implementation for a disclosure component.
+ *
  * @param props - Props for the disclosure.
  * @param state - State for the disclosure, as returned by `useDisclosureState`.
  * @param ref - A ref for the disclosure panel.

package/dist/types/src/dnd/ListDropTargetDelegate.d.ts

@@ -2,17 +2,20 @@ import { Direction, DropTarget, DropTargetDelegate, Node, Orientation, RefObject
 interface ListDropTargetDelegateOptions {
     /**
      * Whether the items are arranged in a stack or grid.
+     *
      * @default 'stack'
      */
     layout?: 'stack' | 'grid';
     /**
      * The primary orientation of the items. Usually this is the
      * direction that the collection scrolls.
+     *
      * @default 'vertical'
      */
     orientation?: Orientation;
     /**
      * The horizontal layout direction.
+     *
      * @default 'ltr'
      */
     direction?: Direction;

package/dist/types/src/dnd/useDrag.d.ts

@@ -6,17 +6,24 @@ export interface DragOptions {
     onDragStart?: (e: DragStartEvent) => void;
     /** Handler that is called when the drag is moved. */
     onDragMove?: (e: DragMoveEvent) => void;
-    /** Handler that is called when the drag operation is ended, either as a result of a drop or a cancellation. */
+    /**
+     * Handler that is called when the drag operation is ended, either as a result of a drop or a
+     * cancellation.
+     */
     onDragEnd?: (e: DragEndEvent) => void;
     /** A function that returns the items being dragged. */
     getItems: () => DragItem[];
     /** The ref of the element that will be rendered as the drag preview while dragging. */
     preview?: RefObject<DragPreviewRenderer | null>;
-    /** Function that returns the drop operations that are allowed for the dragged items. If not provided, all drop operations are allowed. */
+    /**
+     * Function that returns the drop operations that are allowed for the dragged items. If not
+     * provided, all drop operations are allowed.
+     */
     getAllowedDropOperations?: () => DropOperation[];
     /**
-     * Whether the item has an explicit focusable drag affordance to initiate accessible drag and drop mode.
-     * If true, the dragProps will omit these event handlers, and they will be applied to dragButtonProps instead.
+     * Whether the item has an explicit focusable drag affordance to initiate accessible drag and drop
+     * mode. If true, the dragProps will omit these event handlers, and they will be applied to
+     * dragButtonProps instead.
      */
     hasDragButton?: boolean;
     /**

package/dist/types/src/dnd/useDraggableCollection.d.ts

@@ -3,7 +3,7 @@ import { RefObject } from '@react-types/shared';
 export interface DraggableCollectionOptions {
 }
 /**
- * Handles drag interactions for a collection component, with support for traditional mouse and touch
- * based drag and drop, in addition to full parity for keyboard and screen reader users.
+ * Handles drag interactions for a collection component, with support for traditional mouse and
+ * touch based drag and drop, in addition to full parity for keyboard and screen reader users.
  */
 export declare function useDraggableCollection(props: DraggableCollectionOptions, state: DraggableCollectionState, ref: RefObject<HTMLElement | null>): void;

package/dist/types/src/dnd/useDraggableItem.d.ts

@@ -6,15 +6,16 @@ export interface DraggableItemProps {
     /** The key of the draggable item within the collection. */
     key: Key;
     /**
-     * Whether the item has an explicit focusable drag affordance to initiate accessible drag and drop mode.
-     * If true, the dragProps will omit these event handlers, and they will be applied to dragButtonProps instead.
+     * Whether the item has an explicit focusable drag affordance to initiate accessible drag and drop
+     * mode. If true, the dragProps will omit these event handlers, and they will be applied to
+     * dragButtonProps instead.
      */
     hasDragButton?: boolean;
     /**
-     * Whether the item has a primary action (e.g. Enter key or long press) that would
-     * conflict with initiating accessible drag and drop. If true, the Alt key must be held to
-     * start dragging with a keyboard, and long press is disabled until selection mode is entered.
-     * This should be passed from the associated collection item hook (e.g. useOption, useGridListItem, etc.).
+     * Whether the item has a primary action (e.g. Enter key or long press) that would conflict with
+     * initiating accessible drag and drop. If true, the Alt key must be held to start dragging with a
+     * keyboard, and long press is disabled until selection mode is entered. This should be passed
+     * from the associated collection item hook (e.g. useOption, useGridListItem, etc.).
      */
     hasAction?: boolean;
 }

package/dist/types/src/dnd/useDrop.d.ts

@@ -4,8 +4,8 @@ export interface DropOptions {
     /** A ref for the droppable element. */
     ref: RefObject<FocusableElement | null>;
     /**
-     * A function returning the drop operation to be performed when items matching the given types are dropped
-     * on the drop target.
+     * A function returning the drop operation to be performed when items matching the given types are
+     * dropped on the drop target.
      */
     getDropOperation?: (types: IDragTypes, allowedOperations: DropOperation[]) => DropOperation;
     /** A function that returns the drop operation for a specific point within the target. */
@@ -24,8 +24,9 @@ export interface DropOptions {
     /** Handler that is called when a valid drag is dropped on the drop target. */
     onDrop?: (e: DropEvent) => void;
     /**
-     * Whether the item has an explicit focusable drop affordance to initiate accessible drag and drop mode.
-     * If true, the dropProps will omit these event handlers, and they will be applied to dropButtonProps instead.
+     * Whether the item has an explicit focusable drop affordance to initiate accessible drag and drop
+     * mode. If true, the dropProps will omit these event handlers, and they will be applied to
+     * dropButtonProps instead.
      */
     hasDropButton?: boolean;
     /**

package/dist/types/src/dnd/useDroppableCollection.d.ts

@@ -14,7 +14,7 @@ export interface DroppableCollectionResult {
     collectionProps: HTMLAttributes<HTMLElement>;
 }
 /**
- * Handles drop interactions for a collection component, with support for traditional mouse and touch
- * based drag and drop, in addition to full parity for keyboard and screen reader users.
+ * Handles drop interactions for a collection component, with support for traditional mouse and
+ * touch based drag and drop, in addition to full parity for keyboard and screen reader users.
  */
 export declare function useDroppableCollection(props: DroppableCollectionOptions, state: DroppableCollectionState, ref: RefObject<HTMLElement | null>): DroppableCollectionResult;

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

@@ -27,7 +27,7 @@ export declare function isFileDropItem(dropItem: DropItem): dropItem is FileDrop
 /** Returns whether a drop item is a directory. */
 export declare function isDirectoryDropItem(dropItem: DropItem): dropItem is DirectoryDropItem;
 export interface DnDState {
-    /** A ref for the  of the drag items in the current drag session if any. */
+    /** A ref for the of the drag items in the current drag session if any. */
     draggingCollectionRef?: RefObject<HTMLElement | null>;
     /** The set of currently dragged keys. */
     draggingKeys: Set<Key>;

package/dist/types/src/focus/FocusRing.d.ts

@@ -10,6 +10,7 @@ export interface FocusRingProps {
      * Whether to show the focus ring when something
      * inside the container element has focus (true), or
      * only if the container itself has focus (false).
+     *
      * @default false
      */
     within?: boolean;

package/dist/types/src/focus/useFocusRing.d.ts

@@ -4,6 +4,7 @@ export interface AriaFocusRingProps {
      * Whether to show the focus ring when something
      * inside the container element has focus (true), or
      * only if the container itself has focus (false).
+     *
      * @default 'false'
      */
     within?: boolean;

package/dist/types/src/focus/useHasTabbableChild.d.ts

@@ -4,6 +4,7 @@ interface AriaHasTabbableChildOptions {
 }
 /**
  * Returns whether an element has a tabbable child, and updates as children change.
+ *
  * @private
  */
 export declare function useHasTabbableChild(ref: RefObject<Element | null>, options?: AriaHasTabbableChildOptions): boolean;

package/dist/types/src/grid/GridKeyboardDelegate.d.ts

@@ -24,11 +24,15 @@ export declare class GridKeyboardDelegate<T, C extends GridCollection<T>> implem
     protected isCell(node: Node<T>): boolean;
     protected isRow(node: Node<T>): boolean;
     private isDisabled;
-    protected findPreviousKey(fromKey?: Key, pred?: (item: Node<T>) => boolean): Key | null;
-    protected findNextKey(fromKey?: Key, pred?: (item: Node<T>) => boolean): Key | null;
+    protected findPreviousKey(fromKey?: Key, pred?: (item: Node<T>) => boolean, includeDisabled?: boolean): Key | null;
+    protected findNextKey(fromKey?: Key, pred?: (item: Node<T>) => boolean, includeDisabled?: boolean): Key | null;
     protected getKeyForItemInRowByIndex(key: Key, index?: number): Key | null;
-    getKeyBelow(fromKey: Key): Key | null;
-    getKeyAbove(fromKey: Key): Key | null;
+    getKeyBelow(fromKey: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
+    getKeyAbove(fromKey: Key, options?: {
+        includeDisabled?: boolean;
+    }): Key | null;
     getKeyRightOf(key: Key): Key | null;
     getKeyLeftOf(key: Key): Key | null;
     getFirstKey(fromKey?: Key, global?: boolean): Key | null;

package/dist/types/src/grid/useGrid.d.ts

@@ -6,6 +6,7 @@ export interface GridProps extends DOMProps, AriaLabelingProps {
     isVirtualized?: boolean;
     /**
      * Whether typeahead navigation is disabled.
+     *
      * @default false
      */
     disallowTypeAhead?: boolean;
@@ -16,16 +17,20 @@ export interface GridProps extends DOMProps, AriaLabelingProps {
     keyboardDelegate?: KeyboardDelegate;
     /**
      * Whether initial grid focus should be placed on the grid row or grid cell.
+     *
      * @default 'row'
      */
     focusMode?: 'row' | 'cell';
     /**
-     * A function that returns the text that should be announced by assistive technology when a row is added or removed from selection.
+     * A function that returns the text that should be announced by assistive technology when a row is
+     * added or removed from selection.
+     *
      * @default (key) => state.collection.getItem(key)?.textValue
      */
     getRowText?: (key: Key) => string;
     /**
-     * The ref attached to the scrollable body. Used to provided automatic scrolling on item focus for non-virtualized grids.
+     * The ref attached to the scrollable body. Used to provided automatic scrolling on item focus for
+     * non-virtualized grids.
      */
     scrollRef?: RefObject<HTMLElement | null>;
     /** Handler that is called when a user performs an action on the row. */
@@ -38,6 +43,7 @@ export interface GridProps extends DOMProps, AriaLabelingProps {
      * 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';
@@ -49,8 +55,10 @@ export interface GridAria {
     gridProps: DOMAttributes;
 }
 /**
- * Provides the behavior and accessibility implementation for a grid component.
- * A grid displays data in one or more rows and columns and enables a user to navigate its contents via directional navigation keys.
+ * Provides the behavior and accessibility implementation for a grid component. A grid displays data
+ * in one or more rows and columns and enables a user to navigate its contents via directional
+ * navigation keys.
+ *
  * @param props - Props for the grid.
  * @param state - State for the grid, as returned by `useGridState`.
  * @param ref - The ref attached to the grid element.

package/dist/types/src/grid/useGridCell.d.ts

@@ -2,11 +2,17 @@ import { DOMAttributes, FocusableElement, RefObject } from '@react-types/shared'
 import { IGridCollection as GridCollection, GridNode } from 'react-stately/private/grid/GridCollection';
 import { GridState } from 'react-stately/private/grid/useGridState';
 export interface GridCellProps {
-    /** An object representing the grid cell. Contains all the relevant information that makes up the grid cell. */
+    /**
+     * An object representing the grid cell. Contains all the relevant information that makes up the
+     * grid cell.
+     */
     node: GridNode<unknown>;
     /** Whether the grid cell is contained in a virtual scroller. */
     isVirtualized?: boolean;
-    /** Whether the cell or its first focusable child element should be focused when the grid cell is focused. */
+    /**
+     * Whether the cell or its first focusable child element should be focused when the grid cell is
+     * focused.
+     */
     focusMode?: 'child' | 'cell';
     /** Whether selection should occur on press up instead of press down. */
     shouldSelectOnPressUp?: boolean;
@@ -15,8 +21,9 @@ export interface GridCellProps {
     /**
      * Handler that is called when a user performs an action on the cell.
      * Please use onCellAction at the collection level instead.
+     *
      * @deprecated
-     **/
+     */
     onAction?: () => void;
 }
 export interface GridCellAria {
@@ -27,6 +34,7 @@ export interface GridCellAria {
 }
 /**
  * Provides the behavior and accessibility implementation for a cell in a grid.
+ *
  * @param props - Props for the cell.
  * @param state - State of the parent grid, as returned by `useGridState`.
  */

package/dist/types/src/grid/useGridRow.d.ts

@@ -3,7 +3,10 @@ import { IGridCollection as GridCollection, GridNode } from 'react-stately/priva
 import { GridState } from 'react-stately/private/grid/useGridState';
 import { SelectableItemStates } from '../selection/useSelectableItem';
 export interface GridRowProps<T> {
-    /** An object representing the grid row. Contains all the relevant information that makes up the grid row. */
+    /**
+     * An object representing the grid row. Contains all the relevant information that makes up the
+     * grid row.
+     */
     node: GridNode<T>;
     /** Whether the grid row is contained in a virtual scroller. */
     isVirtualized?: boolean;
@@ -12,8 +15,9 @@ export interface GridRowProps<T> {
     /**
      * Handler that is called when a user performs an action on the row.
      * Please use onCellAction at the collection level instead.
+     *
      * @deprecated
-     **/
+     */
     onAction?: () => void;
 }
 export interface GridRowAria extends SelectableItemStates {
@@ -24,6 +28,7 @@ export interface GridRowAria extends SelectableItemStates {
 }
 /**
  * Provides the behavior and accessibility implementation for a row in a grid.
+ *
  * @param props - Props for the row.
  * @param state - State of the parent grid, as returned by `useGridState`.
  */

package/dist/types/src/grid/useGridSelectionAnnouncement.d.ts

@@ -2,7 +2,9 @@ import { Collection, Key, Node } from '@react-types/shared';
 import { SelectionManager } from 'react-stately/private/selection/SelectionManager';
 export interface GridSelectionAnnouncementProps {
     /**
-     * A function that returns the text that should be announced by assistive technology when a row is added or removed from selection.
+     * A function that returns the text that should be announced by assistive technology when a row is
+     * added or removed from selection.
+     *
      * @default (key) => state.collection.getItem(key)?.textValue
      */
     getRowText?: (key: Key) => string;

package/dist/types/src/grid/useGridSelectionCheckbox.d.ts

@@ -12,6 +12,7 @@ export interface GridSelectionCheckboxAria {
 }
 /**
  * Provides the behavior and accessibility implementation for a selection checkbox in a grid.
+ *
  * @param props - Props for the selection checkbox.
  * @param state - State of the grid, as returned by `useGridState`.
  */