react-stately 3.46.0 → 3.47.0

package/dist/types/src/form/useFormValidationState.d.ts

@@ -14,7 +14,10 @@ export interface FormValidationState {
     realtimeValidation: ValidationResult;
     /** Currently displayed validation results, updated when the user commits their changes. */
     displayValidation: ValidationResult;
-    /** Updates the current validation result. Not displayed to the user until `commitValidation` is called. */
+    /**
+     * Updates the current validation result. Not displayed to the user until `commitValidation` is
+     * called.
+     */
     updateValidation(result: ValidationResult): void;
     /** Resets the displayed validation state to valid when the user resets the form. */
     resetValidation(): void;

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

@@ -14,10 +14,11 @@ export interface GridNode<T> extends Node<T> {
     column?: GridNode<T>;
     /**
      * The number of columns spanned by this cell. Use `colSpan` instead.
+     *
      * @deprecated
      */
     colspan?: number;
-    /** The number of columns spanned by this cell.  */
+    /** The number of columns spanned by this cell. */
     colSpan?: number | null;
     /** The column index of this cell, accounting for any colSpans. */
     colIndex?: number | null;

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

@@ -9,17 +9,21 @@ export interface GridState<T, C extends IGridCollection<T>> {
     disabledKeys: Set<Key>;
     /** A selection manager to read and update row selection state. */
     selectionManager: SelectionManager;
-    /** Whether keyboard navigation is disabled, such as when the arrow keys should be handled by a component within a cell. */
+    /**
+     * Whether keyboard navigation is disabled, such as when the arrow keys should be handled by a
+     * component within a cell.
+     */
     isKeyboardNavigationDisabled: boolean;
 }
 export interface GridStateOptions<T, C extends IGridCollection<T>> extends MultipleSelectionStateProps {
     collection: C;
     disabledKeys?: Iterable<Key>;
     focusMode?: 'row' | 'cell';
-    /** @private - do not use unless you know what you're doing. */
+    /** @private - Do not use unless you know what you're doing. */
     UNSAFE_selectionState?: MultipleSelectionState;
 }
 /**
- * Provides state management for a grid component. Handles row selection and focusing a grid cell's focusable child if applicable.
+ * Provides state management for a grid component. Handles row selection and focusing a grid cell's
+ * focusable child if applicable.
  */
 export declare function useGridState<T extends object, C extends IGridCollection<T>>(props: GridStateOptions<T, C>): GridState<T, C>;

package/dist/types/src/layout/GridLayout.d.ts

@@ -7,11 +7,13 @@ import { Size } from '../virtualizer/Size';
 export interface GridLayoutOptions {
     /**
      * The minimum item size.
+     *
      * @default 200 x 200
      */
     minItemSize?: Size;
     /**
      * The maximum item size.
+     *
      * @default Infinity
      */
     maxItemSize?: Size;
@@ -19,35 +21,48 @@ export interface GridLayoutOptions {
      * Whether to preserve the aspect ratio of the `minItemSize`.
      * By default, grid rows may have variable heights. When `preserveAspectRatio`
      * is true, all rows will have equal heights.
+     *
      * @default false
      */
     preserveAspectRatio?: boolean;
     /**
      * The minimum space required between items.
+     *
      * @default 18 x 18
      */
     minSpace?: Size;
     /**
      * The maximum allowed horizontal space between items.
+     *
      * @default Infinity
      */
     maxHorizontalSpace?: number;
     /**
      * The maximum number of columns.
+     *
      * @default Infinity
      */
     maxColumns?: number;
     /**
      * The thickness of the drop indicator.
+     *
      * @default 2
      */
     dropIndicatorThickness?: number;
     /**
-     * The fixed height of a loader element in px. This loader is specifically for
-     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * The fixed height of a loader element in px. This loader is specifically for "load more"
+     * elements rendered when loading more rows at the root level or inside nested row/sections.
+     *
      * @default 48
      */
     loaderHeight?: number;
+    /**
+     * The layout direction. When `'rtl'`, drop target positions (`'before'`/`'after'`)
+     * are computed correctly for right-to-left locales in multi-column grids.
+     *
+     * @default 'ltr'
+     */
+    direction?: 'ltr' | 'rtl';
 }
 /**
  * GridLayout is a virtualizer Layout implementation
@@ -59,6 +74,7 @@ export declare class GridLayout<T, O extends GridLayoutOptions = GridLayoutOptio
     protected gap: Size;
     protected dropIndicatorThickness: number;
     protected numColumns: number;
+    protected direction: 'ltr' | 'rtl';
     private contentSize;
     private layoutInfos;
     private margin;

package/dist/types/src/layout/ListLayout.d.ts

@@ -6,70 +6,92 @@ import { Rect } from '../virtualizer/Rect';
 import { Size } from '../virtualizer/Size';
 export interface ListLayoutOptions {
     /**
-     * The primary orientation of the items. Usually this is the direction that the collection scrolls.
+     * The primary orientation of the items. Usually this is the direction that the collection
+     * scrolls.
+     *
      * @default 'vertical'
      */
     orientation?: Orientation;
     /**
      * The fixed size of a row in px with respect to the applied orientation.
+     *
      * @default 48
      */
     rowSize?: number;
-    /** The estimated size of a row in px with respect to the applied orientation, when row sizes are variable. */
+    /**
+     * The estimated size of a row in px with respect to the applied orientation, when row sizes are
+     * variable.
+     */
     estimatedRowSize?: number;
     /**
      * The fixed size of a section header in px with respect to the applied orientation.
+     *
      * @default 48
      */
     headingSize?: number;
-    /** The estimated size of a section header in px with respect to the applied orientation, when heading sizes are variable. */
+    /**
+     * The estimated size of a section header in px with respect to the applied orientation, when
+     * heading sizes are variable.
+     */
     estimatedHeadingSize?: number;
     /**
-     * The fixed size of a loader element in px with respect to the applied orientation. This loader is specifically for
-     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * The fixed size of a loader element in px with respect to the applied orientation. This loader
+     * is specifically for "load more" elements rendered when loading more rows at the root level or
+     * inside nested row/sections.
+     *
      * @default 48
      */
     loaderSize?: number;
     /**
      * The thickness of the drop indicator.
+     *
      * @default 2
      */
     dropIndicatorThickness?: number;
     /**
      * The gap between items.
+     *
      * @default 0
      */
     gap?: number;
     /**
      * The padding around the list.
+     *
      * @default 0
      */
     padding?: number;
     /**
      * The fixed height of a row in px.
-     * @default 48
+     *
      * @deprecated Use `rowSize` instead.
+     * @default 48
      */
     rowHeight?: number;
-    /** The estimated height of a row, when row heights are variable.
+    /**
+     * The estimated height of a row, when row heights are variable.
+     *
      * @deprecated Use `estimatedRowSize` instead.
      */
     estimatedRowHeight?: number;
     /**
      * The fixed height of a section header in px.
-     * @default 48
+     *
      * @deprecated Use `headingSize` instead.
+     * @default 48
      */
     headingHeight?: number;
-    /** The estimated height of a section header, when the height is variable.
+    /**
+     * The estimated height of a section header, when the height is variable.
+     *
      * @deprecated Use `estimatedHeadingSize` instead.
      */
     estimatedHeadingHeight?: number;
     /**
-     * The fixed height of a loader element in px. This loader is specifically for
-     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
-     * @default 48
+     * The fixed height of a loader element in px. This loader is specifically for "load more"
+     * elements rendered when loading more rows at the root level or inside nested row/sections.
+     *
      * @deprecated Use `loaderSize` instead.
+     * @default 48
      */
     loaderHeight?: number;
 }

package/dist/types/src/layout/TableLayout.d.ts

@@ -8,23 +8,28 @@ import { ITableCollection as TableCollection } from '../table/TableCollection';
 export interface TableLayoutProps extends Omit<ListLayoutOptions, 'orientation' | 'rowSize' | 'estimatedRowSize' | 'headingSize' | 'estimatedHeadingSize' | 'loaderSize'> {
     /**
      * The fixed height of a row in px.
+     *
      * @default 48
      */
     rowHeight?: number;
-    /** The estimated height of a row, when row heights are variable.
+    /**
+     * The estimated height of a row, when row heights are variable.
      */
     estimatedRowHeight?: number;
     /**
      * The fixed height of a section header in px.
+     *
      * @default 48
      */
     headingHeight?: number;
-    /** The estimated height of a section header, when the height is variable.
+    /**
+     * The estimated height of a section header, when the height is variable.
      */
     estimatedHeadingHeight?: number;
     /**
-     * The fixed height of a loader element in px. This loader is specifically for
-     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * The fixed height of a loader element in px. This loader is specifically for "load more"
+     * elements rendered when loading more rows at the root level or inside nested row/sections.
+     *
      * @default 48
      */
     loaderHeight?: number;
@@ -60,6 +65,8 @@ export declare class TableLayout<T, O extends TableLayoutProps = TableLayoutProp
     protected buildColumn(node: GridNode<T>, x: number, y: number): LayoutNode;
     protected isStickyColumn(node: GridNode<T>): boolean;
     protected buildBody(y: number): LayoutNode;
+    protected buildRowGroup(y: number, node: GridNode<T>): LayoutNode;
+    protected buildLoader(node: GridNode<T>, x: number, y: number): LayoutNode;
     protected buildNode(node: GridNode<T>, x: number, y: number): LayoutNode;
     protected buildRow(node: GridNode<T>, x: number, y: number): LayoutNode;
     protected buildCell(node: GridNode<T>, x: number, y: number): LayoutNode;

package/dist/types/src/layout/WaterfallLayout.d.ts

@@ -7,37 +7,44 @@ import { Size } from '../virtualizer/Size';
 export interface WaterfallLayoutOptions {
     /**
      * The minimum item size.
+     *
      * @default 200 x 200
      */
     minItemSize?: Size;
     /**
      * The maximum item size.
+     *
      * @default Infinity
      */
     maxItemSize?: Size;
     /**
      * The minimum space required between items.
+     *
      * @default 18 x 18
      */
     minSpace?: Size;
     /**
      * The maximum allowed horizontal space between items.
+     *
      * @default Infinity
      */
     maxHorizontalSpace?: number;
     /**
      * The maximum number of columns.
+     *
      * @default Infinity
      */
     maxColumns?: number;
     /**
      * The thickness of the drop indicator.
+     *
      * @default 2
      */
     dropIndicatorThickness?: number;
     /**
-     * The fixed height of a loader element in px. This loader is specifically for
-     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * The fixed height of a loader element in px. This loader is specifically for "load more"
+     * elements rendered when loading more rows at the root level or inside nested row/sections.
+     *
      * @default 48
      */
     loaderHeight?: number;

package/dist/types/src/list/useListState.d.ts

@@ -24,8 +24,8 @@ export interface ListState<T> {
  * Provides state management for list-like components. Handles building a collection
  * of items from props, and manages multiple selection state.
  */
-export declare function useListState<T extends object>(props: ListProps<T>): ListState<T>;
+export declare function useListState<T>(props: ListProps<T>): ListState<T>;
 /**
  * Filters a collection using the provided filter function and returns a new ListState.
  */
-export declare function UNSTABLE_useFilteredListState<T extends object>(state: ListState<T>, filterFn: ((nodeValue: string, node: Node<T>) => boolean) | null | undefined): ListState<T>;
+export declare function UNSTABLE_useFilteredListState<T>(state: ListState<T>, filterFn: ((nodeValue: string, node: Node<T>) => boolean) | null | undefined): ListState<T>;

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

@@ -4,6 +4,7 @@ export type MenuTriggerType = 'press' | 'longPress';
 export interface MenuTriggerProps extends OverlayTriggerProps {
     /**
      * How the menu is triggered.
+     *
      * @default 'press'
      */
     trigger?: MenuTriggerType;
@@ -21,7 +22,8 @@ export interface RootMenuTriggerState extends MenuTriggerState {
     openSubmenu: (triggerKey: Key, level: number) => void;
     /** Closes a specific submenu tied to a specific menu item at a specific level. */
     closeSubmenu: (triggerKey: Key, level: number) => void;
-    /** An array of open submenu trigger keys within the menu tree.
+    /**
+     * An array of open submenu trigger keys within the menu tree.
      * The index of key within array matches the submenu level in the tree.
      */
     expandedKeysStack: Key[];

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

@@ -24,7 +24,7 @@ export interface SubmenuTriggerState extends OverlayTriggerState {
     setOpen: () => void;
 }
 /**
- * Manages state for a submenu trigger. Tracks whether the submenu is currently open, the level of the submenu, and
- * controls which item will receive focus when it opens.
+ * Manages state for a submenu trigger. Tracks whether the submenu is currently open, the level of
+ * the submenu, and controls which item will receive focus when it opens.
  */
 export declare function useSubmenuTriggerState(props: SubmenuTriggerProps, state: RootMenuTriggerState): SubmenuTriggerState;

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

@@ -7,9 +7,11 @@ export interface NumberFieldProps extends InputBase, Validation<number>, Focusab
      */
     formatOptions?: Intl.NumberFormatOptions;
     /**
-     * Controls the behavior of the number field when the user blurs the field after editing.
-     * 'snap' will clamp the value to the min/max values, and snap to the nearest step value.
-     * 'validate' will not clamp the value, and will validate that the value is within the min/max range and on a valid step.
+     * Controls the behavior of the number field when the user blurs the field after editing. 'snap'
+     * will clamp the value to the min/max values, and snap to the nearest step value. 'validate' will
+     * not clamp the value, and will validate that the value is within the min/max range and on a
+     * valid step.
+     *
      * @default 'snap'
      */
     commitBehavior?: 'snap' | 'validate';
@@ -36,9 +38,9 @@ export interface NumberFieldState extends FormValidationState {
     /** Whether the current value can be decremented according to the minimum value and step. */
     canDecrement: boolean;
     /**
-     * Validates a user input string according to the current locale and format options.
-     * Values can be partially entered, and may be valid even if they cannot currently be parsed to a number.
-     * Can be used to implement validation as a user types.
+     * Validates a user input string according to the current locale and format options. Values can be
+     * partially entered, and may be valid even if they cannot currently be parsed to a number. Can be
+     * used to implement validation as a user types.
      */
     validate(value: string): boolean;
     /** Sets the current text value of the input. */
@@ -46,10 +48,11 @@ export interface NumberFieldState extends FormValidationState {
     /** Sets the number value. */
     setNumberValue(val: number): void;
     /**
-     * Commits the current input value. The value is parsed to a number, clamped according
-     * to the minimum and maximum values of the field, and snapped to the nearest step value.
-     * This will fire the `onChange` prop with the new value, and if uncontrolled, update the `numberValue`.
+     * Commits the current input value. The value is parsed to a number, clamped according to the
+     * minimum and maximum values of the field, and snapped to the nearest step value. This will fire
+     * the `onChange` prop with the new value, and if uncontrolled, update the `numberValue`.
      * Typically this is called when the field is blurred.
+     *
      * @param value - The value to commit. If not provided, the current input value is used.
      */
     commit(value?: string): void;
@@ -65,12 +68,13 @@ export interface NumberFieldState extends FormValidationState {
 export interface NumberFieldStateOptions extends NumberFieldProps {
     /**
      * The locale that should be used for parsing.
+     *
      * @default 'en-US'
      */
     locale: string;
 }
 /**
- * Provides state management for a number field component. Number fields allow users to enter a number,
- * and increment or decrement the value using stepper buttons.
+ * Provides state management 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 useNumberFieldState(props: NumberFieldStateOptions): NumberFieldState;

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

@@ -3,6 +3,7 @@ import { FormValidationState } from '../form/useFormValidationState';
 export interface RadioGroupProps extends ValueBase<string | null, string>, InputBase, Pick<InputDOMProps, 'name'>, Validation<string>, LabelableProps, HelpTextProps, FocusEvents {
     /**
      * The axis the Radio Button(s) should align with.
+     *
      * @default 'vertical'
      */
     orientation?: Orientation;
@@ -10,8 +11,9 @@ export interface RadioGroupProps extends ValueBase<string | null, string>, Input
 export interface RadioGroupState extends FormValidationState {
     /**
      * The name for the group, used for native form submission.
-     * @deprecated
+     *
      * @private
+     * @deprecated
      */
     readonly name: string;
     /** Whether the radio group is disabled. */
@@ -22,6 +24,7 @@ export interface RadioGroupState extends FormValidationState {
     readonly isRequired: boolean;
     /**
      * Whether the radio group is valid or invalid.
+     *
      * @deprecated Use `isInvalid` instead.
      */
     readonly validationState: ValidationState | null;

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

@@ -9,21 +9,25 @@ type ValidationType<M extends SelectionMode> = M extends 'single' ? Key : Key[];
 export interface SelectProps<T, M extends SelectionMode = 'single'> extends CollectionBase<T>, Omit<InputBase, 'isReadOnly'>, ValueBase<ValueType<M>, ChangeValueType<M>>, Validation<ValidationType<M>>, HelpTextProps, LabelableProps, TextInputBase, FocusableProps {
     /**
      * Whether single or multiple selection is enabled.
+     *
      * @default 'single'
      */
     selectionMode?: M;
     /**
      * The currently selected key in the collection (controlled).
+     *
      * @deprecated
      */
     selectedKey?: Key | null;
     /**
      * The initial selected key in the collection (uncontrolled).
+     *
      * @deprecated
      */
     defaultSelectedKey?: Key | null;
     /**
      * Handler that is called when the selection changes.
+     *
      * @deprecated
      */
     onSelectionChange?: (key: Key | null) => void;
@@ -33,7 +37,10 @@ export interface SelectProps<T, M extends SelectionMode = 'single'> extends Coll
     defaultOpen?: boolean;
     /** Method that is called when the open state of the menu changes. */
     onOpenChange?: (isOpen: boolean) => void;
-    /** Whether the Select should close when an item is selected. Defaults to true if selectionMode is single, false otherwise. */
+    /**
+     * Whether the Select should close when an item is selected. Defaults to true if selectionMode is
+     * single, false otherwise.
+     */
     shouldCloseOnSelect?: boolean;
     /** Whether the select should be allowed to be open when the collection is empty. */
     allowsEmptyCollection?: boolean;
@@ -43,16 +50,19 @@ export interface SelectStateOptions<T, M extends SelectionMode = 'single'> exten
 export interface SelectState<T, M extends SelectionMode = 'single'> extends ListState<T>, OverlayTriggerState, FormValidationState {
     /**
      * The key for the first selected item.
+     *
      * @deprecated
      */
     readonly selectedKey: Key | null;
     /**
      * The default selected key.
+     *
      * @deprecated
      */
     readonly defaultSelectedKey: Key | null;
     /**
      * Sets the selected key.
+     *
      * @deprecated
      */
     setSelectedKey(key: Key | null): void;
@@ -64,6 +74,7 @@ export interface SelectState<T, M extends SelectionMode = 'single'> extends List
     setValue(value: Key | readonly Key[] | null): void;
     /**
      * The value of the first selected item.
+     *
      * @deprecated
      */
     readonly selectedItem: Node<T> | null;
@@ -85,5 +96,5 @@ export interface SelectState<T, M extends SelectionMode = 'single'> extends List
  * of items from props, handles the open state for the popup menu, and manages
  * multiple selection state.
  */
-export declare function useSelectState<T extends object, M extends SelectionMode = 'single'>(props: SelectStateOptions<T, M>): SelectState<T, M>;
+export declare function useSelectState<T, M extends SelectionMode = 'single'>(props: SelectStateOptions<T, M>): SelectState<T, M>;
 export {};

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

@@ -8,7 +8,10 @@ export interface FocusState {
     readonly focusedKey: Key | null;
     /** Whether the first or last child of the focused key should receive focus. */
     readonly childFocusStrategy: FocusStrategy | null;
-    /** Sets the focused key, and optionally, whether the first or last child of that key should receive focus. */
+    /**
+     * Sets the focused key, and optionally, whether the first or last child of that key should
+     * receive focus.
+     */
     setFocusedKey(key: Key | null, child?: FocusStrategy): void;
 }
 export interface SingleSelectionState extends FocusState {

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

@@ -3,6 +3,7 @@ import { MultipleSelectionState } from './types';
 export interface MultipleSelectionStateProps extends MultipleSelection {
     /**
      * How multiple selection should behave in the collection.
+     *
      * @default 'toggle'
      */
     selectionBehavior?: SelectionBehavior;
@@ -10,6 +11,7 @@ export interface MultipleSelectionStateProps extends MultipleSelection {
     allowDuplicateSelectionEvents?: boolean;
     /**
      * Whether `disabledKeys` applies to all interactions, or only selection.
+     *
      * @default 'all'
      */
     disabledBehavior?: DisabledBehavior;