@react-types/shared 3.34.0 → 3.36.0

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "@react-types/shared",
-  "version": "3.34.0",
+  "version": "3.36.0",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
-  "types": "src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/adobe/react-spectrum"
   },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
-  },
+  "types": "src/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a6999bdf494a2e9c0381a5881908328bdd22ddae"
+  "devDependencies": {
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
+  },
+  "gitHead": "1c84a49a1faf50b571c84e00bcf9c60b22ddd03e"
 }

package/src/collections.d.ts

@@ -16,17 +16,17 @@ import {ReactElement, ReactNode} from 'react';
 
 export interface ItemProps<T> extends LinkDOMProps {
   /** Rendered contents of the item or child items. */
-  children: ReactNode,
+  children: ReactNode;
   /** Rendered contents of the item if `children` contains child items. */
-  title?: ReactNode, // label?? contents?
+  title?: ReactNode; // label?? contents?
   /** A string representation of the item's contents, used for features like typeahead. */
-  textValue?: string,
+  textValue?: string;
   /** An accessibility label for this item. */
-  'aria-label'?: string,
+  'aria-label'?: string;
   /** A list of child item objects. Used for dynamic collections. */
-  childItems?: Iterable<T>,
+  childItems?: Iterable<T>;
   /** Whether this item has children, even if not loaded yet. */
-  hasChildItems?: boolean
+  hasChildItems?: boolean;
 }
 
 export type ItemElement<T> = ReactElement<ItemProps<T>> | null;
@@ -35,116 +35,125 @@ export type LoadingState = 'loading' | 'sorting' | 'loadingMore' | 'error' | 'id
 
 export interface AsyncLoadable {
   /** Whether the items are currently loading. */
-  isLoading?: boolean, // possibly isLoadingMore
+  isLoading?: boolean; // possibly isLoadingMore
   /** Handler that is called when more items should be loaded, e.g. while scrolling near the bottom. */
-  onLoadMore?: () => any
+  onLoadMore?: () => any;
 }
 
 export interface SectionProps<T> {
   /** Rendered contents of the section, e.g. a header. */
-  title?: ReactNode,
+  title?: ReactNode;
   /** An accessibility label for the section. */
-  'aria-label'?: string,
+  'aria-label'?: string;
   /** Static child items or a function to render children. */
-  children: ItemElement<T> | ItemElement<T>[] | ItemRenderer<T>,
+  children: ItemElement<T> | ItemElement<T>[] | ItemRenderer<T>;
   /** Item objects in the section. */
-  items?: Iterable<T>
+  items?: Iterable<T>;
 }
 
 export type SectionElement<T> = ReactElement<SectionProps<T>> | null;
 
 export type CollectionElement<T> = SectionElement<T> | ItemElement<T>;
-export type CollectionChildren<T> = CollectionElement<T> | CollectionElement<T>[] | ((item: T) => CollectionElement<T>);
+export type CollectionChildren<T> =
+  | CollectionElement<T>
+  | CollectionElement<T>[]
+  | ((item: T) => CollectionElement<T>);
 export interface CollectionBase<T> {
   /** The contents of the collection. */
-  children: CollectionChildren<T>,
+  children: CollectionChildren<T>;
   /** Item objects in the collection. */
-  items?: Iterable<T>,
-  /** The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with. */
-  disabledKeys?: Iterable<Key>
+  items?: Iterable<T>;
+  /**
+   * The item keys that are disabled. These items cannot be selected, focused, or otherwise
+   * interacted with.
+   */
+  disabledKeys?: Iterable<Key>;
 }
 
-export interface CollectionStateBase<T, C extends Collection<Node<T>> = Collection<Node<T>>> extends Partial<CollectionBase<T>> {
+export interface CollectionStateBase<
+  T,
+  C extends Collection<Node<T>> = Collection<Node<T>>
+> extends Partial<CollectionBase<T>> {
   /** A pre-constructed collection to use instead of building one from items and children. */
-  collection?: C
+  collection?: C;
 }
 
 export interface Expandable {
   /** The currently expanded keys in the collection (controlled). */
-  expandedKeys?: Iterable<Key>,
+  expandedKeys?: Iterable<Key>;
   /** The initial expanded keys in the collection (uncontrolled). */
-  defaultExpandedKeys?: Iterable<Key>,
+  defaultExpandedKeys?: Iterable<Key>;
   /** Handler that is called when items are expanded or collapsed. */
-  onExpandedChange?: (keys: Set<Key>) => any
+  onExpandedChange?: (keys: Set<Key>) => any;
 }
 
 export interface Sortable {
   /** The current sorted column and direction. */
-  sortDescriptor?: SortDescriptor,
+  sortDescriptor?: SortDescriptor;
   /** Handler that is called when the sorted column or direction changes. */
-  onSortChange?: (descriptor: SortDescriptor) => any
+  onSortChange?: (descriptor: SortDescriptor) => any;
 }
 
 export interface SortDescriptor {
   /** The key of the column to sort by. */
-  column: Key,
+  column: Key;
   /** The direction to sort by. */
-  direction: SortDirection
+  direction: SortDirection;
 }
 
 export type SortDirection = 'ascending' | 'descending';
 
 export interface KeyboardDelegate {
   /** Returns the key visually below the given one, or `null` for none. */
-  getKeyBelow?(key: Key): Key | null,
+  getKeyBelow?(key: Key, options?: {includeDisabled?: boolean}): Key | null;
 
   /** Returns the key visually above the given one, or `null` for none. */
-  getKeyAbove?(key: Key): Key | null,
+  getKeyAbove?(key: Key, options?: {includeDisabled?: boolean}): Key | null;
 
   /** Returns the key visually to the left of the given one, or `null` for none. */
-  getKeyLeftOf?(key: Key): Key | null,
+  getKeyLeftOf?(key: Key, options?: {includeDisabled?: boolean}): Key | null;
 
   /** Returns the key visually to the right of the given one, or `null` for none. */
-  getKeyRightOf?(key: Key): Key | null,
+  getKeyRightOf?(key: Key, options?: {includeDisabled?: boolean}): Key | null;
 
   /** Returns the key visually one page below the given one, or `null` for none. */
-  getKeyPageBelow?(key: Key): Key | null,
+  getKeyPageBelow?(key: Key): Key | null;
 
   /** Returns the key visually one page above the given one, or `null` for none. */
-  getKeyPageAbove?(key: Key): Key | null,
+  getKeyPageAbove?(key: Key): Key | null;
 
   /** Returns the first key, or `null` for none. */
-  getFirstKey?(key?: Key | null, global?: boolean): Key | null,
+  getFirstKey?(key?: Key | null, global?: boolean): Key | null;
 
   /** Returns the last key, or `null` for none. */
-  getLastKey?(key?: Key | null, global?: boolean): Key | null,
+  getLastKey?(key?: Key | null, global?: boolean): Key | null;
 
   /** Returns the next key after `fromKey` that matches the given search string, or `null` for none. */
-  getKeyForSearch?(search: string, fromKey?: Key | null): Key | null
+  getKeyForSearch?(search: string, fromKey?: Key | null): Key | null;
 }
 
 export interface Rect {
-  x: number,
-  y: number,
-  width: number,
-  height: number
+  x: number;
+  y: number;
+  width: number;
+  height: number;
 }
 
 export interface Size {
-  width: number,
-  height: number
+  width: number;
+  height: number;
 }
 
 /** A LayoutDelegate provides layout information for collection items. */
 export interface LayoutDelegate {
   /** Returns a rectangle for the item with the given key. */
-  getItemRect(key: Key): Rect | null,
+  getItemRect(key: Key): Rect | null;
   /** Returns the visible rectangle of the collection. */
-  getVisibleRect(): Rect,
+  getVisibleRect(): Rect;
   /** Returns the size of the scrollable content in the collection. */
-  getContentSize(): Size,
+  getContentSize(): Size;
   /** Returns a list of keys between `from` and `to`. */
-  getKeyRange?(from: Key, to: Key): Key[]
+  getKeyRange?(from: Key, to: Key): Key[];
 }
 
 /**
@@ -153,79 +162,80 @@ export interface LayoutDelegate {
  */
 export interface Collection<T> extends Iterable<T> {
   /** The number of items in the collection. */
-  readonly size: number,
+  readonly size: number;
 
   /** Iterate over all keys in the collection. */
-  getKeys(): Iterable<Key>,
+  getKeys(): Iterable<Key>;
 
   /** Get an item by its key. */
-  getItem(key: Key): T | null,
+  getItem(key: Key): T | null;
 
   /** Get an item by the index of its key. */
-  at(idx: number): T | null,
+  at(idx: number): T | null;
 
   /** Get the key that comes before the given key in the collection. */
-  getKeyBefore(key: Key): Key | null,
+  getKeyBefore(key: Key): Key | null;
 
   /** Get the key that comes after the given key in the collection. */
-  getKeyAfter(key: Key): Key | null,
+  getKeyAfter(key: Key): Key | null;
 
   /** Get the first key in the collection. */
-  getFirstKey(): Key | null,
+  getFirstKey(): Key | null;
 
   /** Get the last key in the collection. */
-  getLastKey(): Key | null,
+  getLastKey(): Key | null;
 
   /** Iterate over the child items of the given key. */
-  getChildren?(key: Key): Iterable<T>,
+  getChildren?(key: Key): Iterable<T>;
 
   /** Returns a string representation of the item's contents. */
-  getTextValue?(key: Key): string,
+  getTextValue?(key: Key): string;
 
   /** Filters the collection using the given function. */
-  filter?(filterFn: (nodeValue: string, node: T) => boolean): Collection<T>
+  filter?(filterFn: (nodeValue: string, node: T) => boolean): Collection<T>;
 }
 
 export interface Node<T> {
   /** The type of item this node represents. */
-  type: string,
+  type: string;
   /** A unique key for the node. */
-  key: Key,
+  key: Key;
   /** The object value the node was created from. */
-  value: T | null,
+  value: T | null;
   /** The level of depth this node is at in the hierarchy. */
-  level: number,
+  level: number;
   /** Whether this item has children, even if not loaded yet. */
-  hasChildNodes: boolean,
+  hasChildNodes: boolean;
   /**
    * The loaded children of this node.
+   *
    * @deprecated Use `collection.getChildren(node.key)` instead.
    */
-  childNodes: Iterable<Node<T>>,
+  childNodes: Iterable<Node<T>>;
   /** The rendered contents of this node (e.g. JSX). */
-  rendered: ReactNode,
+  rendered: ReactNode;
   /** A string value for this node, used for features like typeahead. */
-  textValue: string,
+  textValue: string;
   /** An accessibility label for this node. */
-  'aria-label'?: string,
+  'aria-label'?: string;
   /** The index of this node within its parent. */
-  index: number,
+  index: number;
   /** A function that should be called to wrap the rendered node. */
-  wrapper?: (element: ReactElement) => ReactElement,
+  wrapper?: (element: ReactElement) => ReactElement;
   /** The key of the parent node. */
-  parentKey?: Key | null,
+  parentKey?: Key | null;
   /** The key of the node before this node. */
-  prevKey?: Key | null,
+  prevKey?: Key | null;
   /** The key of the node after this node. */
-  nextKey?: Key | null,
+  nextKey?: Key | null;
   /** The first child key of this node. */
-  firstChildKey?: Key | null,
+  firstChildKey?: Key | null;
   /** The last child key of this node. */
-  lastChildKey?: Key | null,
+  lastChildKey?: Key | null;
   /** Additional properties specific to a particular node type. */
-  props?: any,
+  props?: any;
   /** @private */
-  shouldInvalidate?: (context: any) => boolean,
+  shouldInvalidate?: (context: any) => boolean;
   /** A function that renders this node to a React Element in the DOM. */
-  render?: (node: Node<any>) => ReactElement
+  render?: (node: Node<any>) => ReactElement;
 }

package/src/dna.d.ts

@@ -435,11 +435,7 @@ export type ColorValueV6 =
   | 'magenta-1400'
   | SemanticColorValue;
 
-type SemanticColorValue =
-  | 'negative'
-  | 'notice'
-  | 'positive'
-  | 'informative';
+type SemanticColorValue = 'negative' | 'notice' | 'positive' | 'informative';
 
 type BorderColorAlias =
   | 'negative'
@@ -459,45 +455,18 @@ type BorderColorAlias =
   | 'translucent-dark'
   | 'translucent-darker';
 
-type BackgroundColorAlias =
-  | 'default'
-  | 'disabled'
-  | 'transparent'
-  | 'label-gray';
+type BackgroundColorAlias = 'default' | 'disabled' | 'transparent' | 'label-gray';
 
-export type IconColorValue =
-  | 'negative'
-  | 'notice'
-  | 'positive'
-  | 'informative';
+export type IconColorValue = 'negative' | 'notice' | 'positive' | 'informative';
 
-export type BorderSizeValue =
-  | 'thin'
-  | 'thick'
-  | 'thicker'
-  | 'thickest'
-  | 'none';
+export type BorderSizeValue = 'thin' | 'thick' | 'thicker' | 'thickest' | 'none';
 
-export type BorderRadiusValue =
-  | 'xsmall'
-  | 'small'
-  | 'regular'
-  | 'medium'
-  | 'large';
+export type BorderRadiusValue = 'xsmall' | 'small' | 'regular' | 'medium' | 'large';
 
-export type BorderColorValue =
-  | 'default'
-  | BorderColorAlias
-  | ColorValue;
+export type BorderColorValue = 'default' | BorderColorAlias | ColorValue;
 
-export type BorderColorValueV6 =
-  | BorderColorAlias
-  | ColorValueV6;
+export type BorderColorValueV6 = BorderColorAlias | ColorValueV6;
 
-export type BackgroundColorValue =
-  | BackgroundColorAlias
-  | ColorValue;
+export type BackgroundColorValue = BackgroundColorAlias | ColorValue;
 
-export type BackgroundColorValueV6 =
-  | BackgroundColorAlias
-  | ColorValueV6;
+export type BackgroundColorValueV6 = BackgroundColorAlias | ColorValueV6;