@deephaven/components 0.72.1-beta.5 → 0.72.1-core-plugins.9

package/dist/spectrum/shared.d.ts

@@ -1,12 +1,18 @@
+/// <reference types="react" />
+import type { ItemElement, ItemRenderer, SectionProps as SpectrumSectionProps } from '@react-types/shared';
+export { Item } from '@adobe/react-spectrum';
+export type { ItemProps } from '@react-types/shared';
+export type ItemElementOrPrimitive<T = unknown> = number | string | boolean | ItemElement<T>;
+export type ItemsChildren<T> = ItemElement<T> | ItemElement<T>[] | ItemRenderer<T>;
+export type ItemsOrPrimitiveChildren<T> = ItemElementOrPrimitive<T> | ItemElementOrPrimitive<T>[] | ItemRenderer<T>;
 /**
- * Wrapping Spectrum `Item` and `Section` components will break functionality
- * due to the way they are consumed by collection components. They are only used
- * to pass data and don't render anything on their own, so they don't need to be
- * wrapped. If we do ever need to wrap them for whatever reason, the static
- * `getCollectionNode` method will need to be implemented.
- * See https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Item.ts#L17
- *     https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Section.ts#L18
+ * Spectrum SectionProps augmented with support for primitive item children.
  */
-export { Item, Section } from '@adobe/react-spectrum';
-export type { ItemProps, SectionProps } from '@react-types/shared';
+export type SectionProps<T> = Omit<SpectrumSectionProps<T>, 'children'> & {
+    children: ItemsOrPrimitiveChildren<T>;
+};
+/**
+ * Re-export Spectrum Section component with augmented props type.
+ */
+export declare const Section: <T>(props: SectionProps<T>) => JSX.Element;
 //# sourceMappingURL=shared.d.ts.map

package/dist/spectrum/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/spectrum/shared.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACtD,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/spectrum/shared.ts"],"names":[],"mappings":";AAUA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,YAAY,IAAI,oBAAoB,EACrC,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,YAAY,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAMrD,MAAM,MAAM,sBAAsB,CAAC,CAAC,GAAG,OAAO,IAC1C,MAAM,GACN,MAAM,GACN,OAAO,GACP,WAAW,CAAC,CAAC,CAAC,CAAC;AAEnB,MAAM,MAAM,aAAa,CAAC,CAAC,IACvB,WAAW,CAAC,CAAC,CAAC,GACd,WAAW,CAAC,CAAC,CAAC,EAAE,GAChB,YAAY,CAAC,CAAC,CAAC,CAAC;AAEpB,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAClC,sBAAsB,CAAC,CAAC,CAAC,GACzB,sBAAsB,CAAC,CAAC,CAAC,EAAE,GAC3B,YAAY,CAAC,CAAC,CAAC,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG;IACxE,QAAQ,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,iCAEf,WAAW,CAAC"}

package/dist/spectrum/shared.js

@@ -7,5 +7,20 @@
  * See https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Item.ts#L17
  *     https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Section.ts#L18
  */
-export { Item, Section } from '@adobe/react-spectrum';
+import { Section as SpectrumSection } from '@adobe/react-spectrum';
+export { Item } from '@adobe/react-spectrum';
+
+/*
+ * We support primitive values as shorthand for `Item` elements in certain
+ * components. This type represents this augmentation of the Spectrum types.
+ */
+
+/**
+ * Spectrum SectionProps augmented with support for primitive item children.
+ */
+
+/**
+ * Re-export Spectrum Section component with augmented props type.
+ */
+export var Section = SpectrumSection;
 //# sourceMappingURL=shared.js.map

package/dist/spectrum/shared.js.map

@@ -1 +1 @@
-{"version":3,"file":"shared.js","names":["Item","Section"],"sources":["../../src/spectrum/shared.ts"],"sourcesContent":["/**\n * Wrapping Spectrum `Item` and `Section` components will break functionality\n * due to the way they are consumed by collection components. They are only used\n * to pass data and don't render anything on their own, so they don't need to be\n * wrapped. If we do ever need to wrap them for whatever reason, the static\n * `getCollectionNode` method will need to be implemented.\n * See https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Item.ts#L17\n *     https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Section.ts#L18\n */\nexport { Item, Section } from '@adobe/react-spectrum';\nexport type { ItemProps, SectionProps } from '@react-types/shared';\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,IAAI,EAAEC,OAAO,QAAQ,uBAAuB"}
+{"version":3,"file":"shared.js","names":["Section","SpectrumSection","Item"],"sources":["../../src/spectrum/shared.ts"],"sourcesContent":["/**\n * Wrapping Spectrum `Item` and `Section` components will break functionality\n * due to the way they are consumed by collection components. They are only used\n * to pass data and don't render anything on their own, so they don't need to be\n * wrapped. If we do ever need to wrap them for whatever reason, the static\n * `getCollectionNode` method will need to be implemented.\n * See https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Item.ts#L17\n *     https://github.com/adobe/react-spectrum/blob/main/packages/%40react-stately/collections/src/Section.ts#L18\n */\nimport { Section as SpectrumSection } from '@adobe/react-spectrum';\nimport type {\n  ItemElement,\n  ItemRenderer,\n  SectionProps as SpectrumSectionProps,\n} from '@react-types/shared';\n\nexport { Item } from '@adobe/react-spectrum';\nexport type { ItemProps } from '@react-types/shared';\n\n/*\n * We support primitive values as shorthand for `Item` elements in certain\n * components. This type represents this augmentation of the Spectrum types.\n */\nexport type ItemElementOrPrimitive<T = unknown> =\n  | number\n  | string\n  | boolean\n  | ItemElement<T>;\n\nexport type ItemsChildren<T> =\n  | ItemElement<T>\n  | ItemElement<T>[]\n  | ItemRenderer<T>;\n\nexport type ItemsOrPrimitiveChildren<T> =\n  | ItemElementOrPrimitive<T>\n  | ItemElementOrPrimitive<T>[]\n  | ItemRenderer<T>;\n\n/**\n * Spectrum SectionProps augmented with support for primitive item children.\n */\nexport type SectionProps<T> = Omit<SpectrumSectionProps<T>, 'children'> & {\n  children: ItemsOrPrimitiveChildren<T>;\n};\n\n/**\n * Re-export Spectrum Section component with augmented props type.\n */\nexport const Section = SpectrumSection as <T>(\n  props: SectionProps<T>\n) => JSX.Element;\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,OAAO,IAAIC,eAAe,QAAQ,uBAAuB;AAOlE,SAASC,IAAI,QAAQ,uBAAuB;;AAG5C;AACA;AACA;AACA;;AAiBA;AACA;AACA;;AAKA;AACA;AACA;AACA,OAAO,IAAMF,OAAO,GAAGC,eAEP"}

package/dist/spectrum/utils/index.d.ts

@@ -1,3 +1,10 @@
 export * from './itemUtils';
+export * from './itemWrapperUtils';
+export * from './propsUtils';
 export * from './themeUtils';
+export * from './useOnChangeTrackUncontrolled';
+export * from './useRenderNormalizedItem';
+export * from './useStaticItemInitialScrollPosition';
+export * from './useStringifiedMultiSelection';
+export * from './useStringifiedSelection';
 //# sourceMappingURL=index.d.ts.map

package/dist/spectrum/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spectrum/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spectrum/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC"}

package/dist/spectrum/utils/index.js

@@ -1,3 +1,10 @@
 export * from "./itemUtils.js";
+export * from "./itemWrapperUtils.js";
+export * from "./propsUtils.js";
 export * from "./themeUtils.js";
+export * from "./useOnChangeTrackUncontrolled.js";
+export * from "./useRenderNormalizedItem.js";
+export * from "./useStaticItemInitialScrollPosition.js";
+export * from "./useStringifiedMultiSelection.js";
+export * from "./useStringifiedSelection.js";
 //# sourceMappingURL=index.js.map

package/dist/spectrum/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../src/spectrum/utils/index.ts"],"sourcesContent":["export * from './itemUtils';\nexport * from './themeUtils';\n"],"mappings":""}
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/spectrum/utils/index.ts"],"sourcesContent":["export * from './itemUtils';\nexport * from './itemWrapperUtils';\nexport * from './propsUtils';\nexport * from './themeUtils';\nexport * from './useOnChangeTrackUncontrolled';\nexport * from './useRenderNormalizedItem';\nexport * from './useStaticItemInitialScrollPosition';\nexport * from './useStringifiedMultiSelection';\nexport * from './useStringifiedSelection';\n"],"mappings":""}

package/dist/spectrum/utils/itemUtils.d.ts

@@ -1,10 +1,13 @@
 import { Key, ReactElement, ReactNode } from 'react';
-import { SpectrumPickerProps } from '@adobe/react-spectrum';
 import type { ItemRenderer } from '@react-types/shared';
-import { KeyedItem } from '@deephaven/utils';
-import { ItemProps, SectionProps } from '../shared';
+import { KeyedItem, SelectionT } from '@deephaven/utils';
+import { ItemElementOrPrimitive, ItemProps, SectionProps } from '../shared';
 import { PopperOptions } from '../../popper';
-export declare const INVALID_ITEM_ERROR_MESSAGE = "Items must be strings, numbers, booleans, <Item> or <Section> elements:";
+/**
+ * `Item.textValue` prop needs to be a non-empty string for accessibility
+ * purposes. This is not displayed in the UI.
+ */
+export declare const ITEM_EMPTY_STRING_TEXT_VALUE = "Empty";
 /**
  * React Spectrum <Section> supports an `ItemRenderer` function as a child. The
  * DH picker makes use of this internally, but we don't want to support it as
@@ -13,26 +16,46 @@ export declare const INVALID_ITEM_ERROR_MESSAGE = "Items must be strings, number
 type SectionPropsNoItemRenderer<T> = Omit<SectionProps<T>, 'children'> & {
     children: Exclude<SectionProps<T>['children'], ItemRenderer<T>>;
 };
-type ItemElement = ReactElement<ItemProps<unknown>>;
-export type SectionElement = ReactElement<SectionPropsNoItemRenderer<unknown>>;
-export type ItemElementOrPrimitive = number | string | boolean | ItemElement;
-export type ItemOrSection = ItemElementOrPrimitive | SectionElement;
+export type ItemElement<T = unknown> = ReactElement<ItemProps<T>>;
+export type SectionElement<T = unknown> = ReactElement<SectionPropsNoItemRenderer<T>>;
+export type ItemOrSection<T = unknown> = ItemElementOrPrimitive<T> | SectionElement<T>;
+export type ItemIconSlot = 'icon' | 'image' | 'illustration';
 /**
  * Augment the Spectrum selection key type to include boolean values.
  * Spectrum collection components already supports this, but the built in types
  * don't reflect it.
  */
 export type ItemKey = Key | boolean;
+export type ItemSelection = SelectionT<ItemKey>;
 /**
  * Augment the Spectrum selection change handler type to include boolean keys.
  * Spectrum components already supports this, but the built in types don't
  * reflect it.
  */
 export type ItemSelectionChangeHandler = (key: ItemKey) => void;
+export interface MultipleItemSelectionProps {
+    selectedKeys?: 'all' | Iterable<ItemKey>;
+    defaultSelectedKeys?: 'all' | Iterable<ItemKey>;
+    disabledKeys?: Iterable<ItemKey>;
+    /**
+     * Handler that is called when the selection change.
+     * Note that under the hood, this is just an alias for Spectrum's
+     * `onSelectionChange`. We are renaming for better consistency with other
+     * components.
+     */
+    onChange?: (keys: ItemSelection) => void;
+    /**
+     * Handler that is called when the selection changes.
+     * @deprecated Use `onChange` instead
+     */
+    onSelectionChange?: (keys: ItemSelection) => void;
+}
 export interface NormalizedItemData {
     key?: ItemKey;
     content: ReactNode;
-    textValue?: string;
+    description?: ReactNode;
+    icon?: ReactNode;
+    textValue: string | undefined;
 }
 export interface NormalizedSectionData {
     key?: Key;
@@ -47,9 +70,9 @@ export interface NormalizedSectionData {
  * `KeyedItem` interface to be compatible with Windowed data utils
  * (e.g. `useViewportData`).
  */
-export type NormalizedItem = KeyedItem<NormalizedItemData, ItemKey | undefined>;
-export type NormalizedSection = KeyedItem<NormalizedSectionData, Key | undefined>;
-export type NormalizedSpectrumPickerProps = SpectrumPickerProps<NormalizedItem>;
+export type NormalizedItem = KeyedItem<NormalizedItemData, ItemKey>;
+export type NormalizedSection = KeyedItem<NormalizedSectionData, Key>;
+export type NormalizedItemOrSection<TItemOrSection extends ItemOrSection> = TItemOrSection extends SectionElement ? NormalizedSection : NormalizedItem;
 export type TooltipOptions = {
     placement: PopperOptions['placement'];
 };
@@ -62,26 +85,54 @@ export type TooltipOptions = {
  * @param item The normalized item or section
  * @returns The `key` of the item or section
  */
-export declare function getItemKey<TItem extends NormalizedItem | NormalizedSection, TKey extends TItem extends NormalizedItem ? ItemKey | undefined : TItem extends NormalizedSection ? Key | undefined : undefined>(item: TItem | null | undefined): TKey;
+export declare function getItemKey<TItem extends NormalizedItem | NormalizedSection, TKey extends TItem extends NormalizedItem ? ItemKey : TItem extends NormalizedSection ? Key : undefined>(item: TItem | null | undefined): TKey;
+/**
+ * Determine Item `textValue` based on the `textValue` prop or primitive children
+ * value.
+ * @param item The item to get the text value for
+ * @returns The text value of the item
+ */
+export declare function getItemTextValue<T>(item: ItemElement<T>): string | undefined;
+/**
+ * Get the position of the item with the given selected key in a list of items.
+ * @param items The items to search
+ * @param itemHeight The height of each item
+ * @param selectedKey The key of the selected item
+ * @param topOffset The top offset of the list
+ * @returns The position of the selected item or the top offset if not found
+ */
+export declare function getPositionOfSelectedItemElement<TKey extends string | number | boolean | undefined>({ items, itemHeight, selectedKey, topOffset, }: {
+    items: ItemElement[];
+    selectedKey: TKey | null | undefined;
+    itemHeight: number;
+    topOffset: number;
+}): Promise<number>;
 /**
  * Determine if a node is a Section element.
  * @param node The node to check
  * @returns True if the node is a Section element
  */
-export declare function isSectionElement<T>(node: ReactNode): node is ReactElement<SectionProps<T>>;
+export declare function isSectionElement<T>(node: ReactNode): node is SectionElement<T>;
 /**
  * Determine if a node is an Item element.
  * @param node The node to check
  * @returns True if the node is an Item element
  */
-export declare function isItemElement<T>(node: ReactNode): node is ReactElement<ItemProps<T>>;
+export declare function isItemElement<T>(node: ReactNode): node is ItemElement<T>;
 /**
- * Determine if a node is an array containing normalized items with keys.
- * Note that this only checks the first node in the array.
+ * Determine if a node is an Item element containing a child `Text` element with
+ * a `slot` prop set to `description`.
  * @param node The node to check
- * @returns True if the node is a normalized item with keys array
+ * @returns True if the node is an Item element with a description
  */
-export declare function isNormalizedItemsWithKeysList(node: ItemOrSection | ItemOrSection[] | (NormalizedItem | NormalizedSection)[]): node is (NormalizedItem | NormalizedSection)[];
+export declare function isItemElementWithDescription<T>(node: ReactNode): node is ReactElement<ItemProps<T>>;
+/**
+ * Determine if a node is an array containing normalized items or sections with
+ * keys. Note that this only checks the first node in the array.
+ * @param node The node to check
+ * @returns True if the node is a normalized item or section with keys array
+ */
+export declare function isNormalizedItemsWithKeysList<TItemOrSection extends ItemOrSection>(node: TItemOrSection | TItemOrSection[] | NormalizedItemOrSection<TItemOrSection>[]): node is NormalizedItemOrSection<TItemOrSection>[];
 /**
  * Determine if an object is a normalized section.
  * @param maybeNormalizedSection The object to check
@@ -95,17 +146,19 @@ export declare function isNormalizedSection(maybeNormalizedSection: NormalizedIt
  * @returns True if the node is an item or section
  */
 export declare function isItemOrSection(node: ReactNode): node is ItemOrSection;
-/**
- * Get normalized items from an item or array of items.
- * @param itemsOrSections An item or array of items
- * @returns An array of normalized items
- */
-export declare function normalizeItemList(itemsOrSections: ItemOrSection | ItemOrSection[] | NormalizedItem[]): (NormalizedItem | NormalizedSection)[];
 /**
  * Returns a TooltipOptions object or null if options is false or null.
- * @param options
+ * @param options Tooltip options
+ * @param placement Default placement for the tooltip if `options` is set
+ * explicitly to `true`
  * @returns TooltipOptions or null
  */
-export declare function normalizeTooltipOptions(options?: boolean | TooltipOptions | null): TooltipOptions | null;
+export declare function normalizeTooltipOptions(options?: boolean | TooltipOptions | null, placement?: TooltipOptions['placement']): TooltipOptions | null;
+/**
+ * Convert a selection of `ItemKey`s to a selection of strings.
+ * @param itemKeys The selection of `ItemKey`s
+ * @returns The selection of strings
+ */
+export declare function itemSelectionToStringSet<TKeys extends 'all' | Iterable<ItemKey> | undefined, TResult extends TKeys extends 'all' ? 'all' : TKeys extends Iterable<ItemKey> ? Set<string> : undefined>(itemKeys: TKeys): TResult;
 export {};
 //# sourceMappingURL=itemUtils.d.ts.map

package/dist/spectrum/utils/itemUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"itemUtils.d.ts","sourceRoot":"","sources":["../../../src/spectrum/utils/itemUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAQ,SAAS,EAAW,YAAY,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C,eAAO,MAAM,0BAA0B,4EACoC,CAAC;AAE5E;;;;GAIG;AACH,KAAK,0BAA0B,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG;IACvE,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACjE,CAAC;AAEF,KAAK,WAAW,GAAG,YAAY,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACpD,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,sBAAsB,GAAG,cAAc,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC;AAEpC;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC;AAEhF,MAAM,MAAM,iBAAiB,GAAG,SAAS,CACvC,qBAAqB,EACrB,GAAG,GAAG,SAAS,CAChB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;AAEhF,MAAM,MAAM,cAAc,GAAG;IAAE,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,CAAA;CAAE,CAAC;AAEvE;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,KAAK,SAAS,cAAc,GAAG,iBAAiB,EAChD,IAAI,SAAS,KAAK,SAAS,cAAc,GACrC,OAAO,GAAG,SAAS,GACnB,KAAK,SAAS,iBAAiB,GAC/B,GAAG,GAAG,SAAS,GACf,SAAS,EACb,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAEtC;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,SAAS,GACd,IAAI,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEvC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,IAAI,EAAE,SAAS,GACd,IAAI,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,aAAa,GAAG,aAAa,EAAE,GAAG,CAAC,cAAc,GAAG,iBAAiB,CAAC,EAAE,GAC7E,IAAI,IAAI,CAAC,cAAc,GAAG,iBAAiB,CAAC,EAAE,CAUhD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,sBAAsB,EAAE,cAAc,GAAG,iBAAiB,GACzD,sBAAsB,IAAI,iBAAiB,CAK7C;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,IAAI,aAAa,CAQtE;AAiGD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,aAAa,GAAG,aAAa,EAAE,GAAG,cAAc,EAAE,GAClE,CAAC,cAAc,GAAG,iBAAiB,CAAC,EAAE,CAWxC;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,CAAC,EAAE,OAAO,GAAG,cAAc,GAAG,IAAI,GACxC,cAAc,GAAG,IAAI,CAUvB"}
+{"version":3,"file":"itemUtils.d.ts","sourceRoot":"","sources":["../../../src/spectrum/utils/itemUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAe,SAAS,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAEL,sBAAsB,EACtB,SAAS,EAET,YAAY,EACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C;;;GAGG;AACH,eAAO,MAAM,4BAA4B,UAAU,CAAC;AAEpD;;;;GAIG;AACH,KAAK,0BAA0B,CAAC,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG;IACvE,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAClE,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,YAAY,CACpD,0BAA0B,CAAC,CAAC,CAAC,CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,CAAC,GAAG,OAAO,IACjC,sBAAsB,CAAC,CAAC,CAAC,GACzB,cAAc,CAAC,CAAC,CAAC,CAAC;AAKtB,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,GAAG,cAAc,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC;AAEpC,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;AAEhE,MAAM,WAAW,0BAA0B;IACzC,YAAY,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzC,mBAAmB,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChD,YAAY,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAC;IAEzC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;AAEpE,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;AAEtE,MAAM,MAAM,uBAAuB,CAAC,cAAc,SAAS,aAAa,IACtE,cAAc,SAAS,cAAc,GAAG,iBAAiB,GAAG,cAAc,CAAC;AAE7E,MAAM,MAAM,cAAc,GAAG;IAAE,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,CAAA;CAAE,CAAC;AAEvE;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACxB,KAAK,SAAS,cAAc,GAAG,iBAAiB,EAChD,IAAI,SAAS,KAAK,SAAS,cAAc,GACrC,OAAO,GACP,KAAK,SAAS,iBAAiB,GAC/B,GAAG,GACH,SAAS,EACb,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,SAAS,CAW5E;AAED;;;;;;;GAOG;AACH,wBAAsB,gCAAgC,CACpD,IAAI,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,EAClD,EACA,KAAK,EACL,UAAU,EACV,WAAW,EACX,SAAS,GACV,EAAE;IACD,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,WAAW,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBlB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,SAAS,GACd,IAAI,IAAI,cAAc,CAAC,CAAC,CAAC,CAE3B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC,CAExE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,EAC5C,IAAI,EAAE,SAAS,GACd,IAAI,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAiBpC;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,cAAc,SAAS,aAAa,EAEpC,IAAI,EACA,cAAc,GACd,cAAc,EAAE,GAChB,uBAAuB,CAAC,cAAc,CAAC,EAAE,GAC5C,IAAI,IAAI,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAUnD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,sBAAsB,EAAE,cAAc,GAAG,iBAAiB,GACzD,sBAAsB,IAAI,iBAAiB,CAK7C;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,IAAI,aAAa,CAQtE;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,CAAC,EAAE,OAAO,GAAG,cAAc,GAAG,IAAI,EACzC,SAAS,GAAE,cAAc,CAAC,WAAW,CAAW,GAC/C,cAAc,GAAG,IAAI,CAUvB;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,SAAS,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,EACnD,OAAO,SAAS,KAAK,SAAS,KAAK,GAC/B,KAAK,GACL,KAAK,SAAS,QAAQ,CAAC,OAAO,CAAC,GAC/B,GAAG,CAAC,MAAM,CAAC,GACX,SAAS,EACb,QAAQ,EAAE,KAAK,GAAG,OAAO,CAM1B"}

package/dist/spectrum/utils/itemUtils.js

@@ -1,8 +1,15 @@
-import { isValidElement } from 'react';
-import Log from '@deephaven/log';
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+import { isElementOfType } from '@deephaven/react-hooks';
+import { ensureArray } from '@deephaven/utils';
 import { Item, Section } from "../shared.js";
-var log = Log.module('itemUtils');
-export var INVALID_ITEM_ERROR_MESSAGE = 'Items must be strings, numbers, booleans, <Item> or <Section> elements:';
+import { Text } from "../Text.js";
+import ItemContent from "../ItemContent.js";
+/**
+ * `Item.textValue` prop needs to be a non-empty string for accessibility
+ * purposes. This is not displayed in the UI.
+ */
+export var ITEM_EMPTY_STRING_TEXT_VALUE = 'Empty';
 
 /**
  * React Spectrum <Section> supports an `ItemRenderer` function as a child. The
@@ -10,18 +17,19 @@ export var INVALID_ITEM_ERROR_MESSAGE = 'Items must be strings, numbers, boolean
  * an incoming prop.
  */
 
+// Picker uses `icon` slot. ListView can use `image` or `illustration` slots.
+// https://github.com/adobe/react-spectrum/blob/main/packages/%40react-spectrum/picker/src/Picker.tsx#L194
+// https://github.com/adobe/react-spectrum/blob/main/packages/%40react-spectrum/list/src/ListViewItem.tsx#L266-L267
 /**
  * Augment the Spectrum selection key type to include boolean values.
  * Spectrum collection components already supports this, but the built in types
  * don't reflect it.
  */
-
 /**
  * Augment the Spectrum selection change handler type to include boolean keys.
  * Spectrum components already supports this, but the built in types don't
  * reflect it.
  */
-
 /**
  * Spectrum collection components support a variety of item types, including
  * strings, numbers, booleans, and more complex React elements. This type
@@ -30,7 +38,6 @@ export var INVALID_ITEM_ERROR_MESSAGE = 'Items must be strings, numbers, boolean
  * `KeyedItem` interface to be compatible with Windowed data utils
  * (e.g. `useViewportData`).
  */
-
 /**
  * DH wrappers of Spectrum collection components use a normalized item that
  * includes a `key` prop and an optional `item` prop. This is mostly to support
@@ -45,13 +52,62 @@ export function getItemKey(item) {
   return (_item$item$key = item === null || item === void 0 ? void 0 : (_item$item = item.item) === null || _item$item === void 0 ? void 0 : _item$item.key) !== null && _item$item$key !== void 0 ? _item$item$key : item === null || item === void 0 ? void 0 : item.key;
 }
 
+/**
+ * Determine Item `textValue` based on the `textValue` prop or primitive children
+ * value.
+ * @param item The item to get the text value for
+ * @returns The text value of the item
+ */
+export function getItemTextValue(item) {
+  if (item.props.textValue == null) {
+    var itemKeyStr = item.key == null ? undefined : String(item.key);
+    return ['string', 'boolean', 'number'].includes(typeof item.props.children) ? String(item.props.children) : itemKeyStr;
+  }
+  return item.props.textValue === '' ? ITEM_EMPTY_STRING_TEXT_VALUE : item.props.textValue;
+}
+
+/**
+ * Get the position of the item with the given selected key in a list of items.
+ * @param items The items to search
+ * @param itemHeight The height of each item
+ * @param selectedKey The key of the selected item
+ * @param topOffset The top offset of the list
+ * @returns The position of the selected item or the top offset if not found
+ */
+export function getPositionOfSelectedItemElement(_x) {
+  return _getPositionOfSelectedItemElement.apply(this, arguments);
+}
+
 /**
  * Determine if a node is a Section element.
  * @param node The node to check
  * @returns True if the node is a Section element
  */
+function _getPositionOfSelectedItemElement() {
+  _getPositionOfSelectedItemElement = _asyncToGenerator(function* (_ref) {
+    var {
+      items,
+      itemHeight,
+      selectedKey,
+      topOffset
+    } = _ref;
+    var position = topOffset;
+    if (selectedKey == null) {
+      return position;
+    }
+    for (var i = 0; i < items.length; i += 1) {
+      var item = items[i];
+      if (item.key === selectedKey) {
+        return position;
+      }
+      position += itemHeight;
+    }
+    return topOffset;
+  });
+  return _getPositionOfSelectedItemElement.apply(this, arguments);
+}
 export function isSectionElement(node) {
-  return /*#__PURE__*/isValidElement(node) && node.type === Section;
+  return isElementOfType(node, Section);
 }
 
 /**
@@ -60,14 +116,35 @@ export function isSectionElement(node) {
  * @returns True if the node is an Item element
  */
 export function isItemElement(node) {
-  return /*#__PURE__*/isValidElement(node) && node.type === Item;
+  return isElementOfType(node, Item);
+}
+
+/**
+ * Determine if a node is an Item element containing a child `Text` element with
+ * a `slot` prop set to `description`.
+ * @param node The node to check
+ * @returns True if the node is an Item element with a description
+ */
+export function isItemElementWithDescription(node) {
+  if (!isItemElement(node)) {
+    return false;
+  }
+
+  // If children are wrapped in `ItemContent`, go down 1 level
+  var children = isElementOfType(node.props.children, ItemContent) ? node.props.children.props.children : node.props.children;
+  var childrenArray = ensureArray(children);
+  var result = childrenArray.some(child => {
+    var _child$props;
+    return isElementOfType(child, Text) && ((_child$props = child.props) === null || _child$props === void 0 ? void 0 : _child$props.slot) === 'description';
+  });
+  return result;
 }
 
 /**
- * Determine if a node is an array containing normalized items with keys.
- * Note that this only checks the first node in the array.
+ * Determine if a node is an array containing normalized items or sections with
+ * keys. Note that this only checks the first node in the array.
  * @param node The node to check
- * @returns True if the node is a normalized item with keys array
+ * @returns True if the node is a normalized item or section with keys array
  */
 export function isNormalizedItemsWithKeysList(node) {
   if (!Array.isArray(node)) {
@@ -98,117 +175,35 @@ export function isItemOrSection(node) {
   return typeof node === 'string' || typeof node === 'number' || typeof node === 'boolean' || isItemElement(node) || isSectionElement(node);
 }
 
-/**
- * Determine the `key` of an item or section.
- * @param itemOrSection The item or section
- * @returns A `ItemKey` for the item or undefined if a key can't be determined
- */
-
-function normalizeItemKey(itemOrSection) {
-  var _itemOrSection$props$;
-  // string, number, or boolean
-  if (typeof itemOrSection !== 'object') {
-    return itemOrSection;
-  }
-
-  // If `key` prop is explicitly set
-  if (itemOrSection.key != null) {
-    return itemOrSection.key;
-  }
-
-  // Section element
-  if (isSectionElement(itemOrSection)) {
-    return typeof itemOrSection.props.title === 'string' ? itemOrSection.props.title : undefined;
-  }
-
-  // Item element
-  return (_itemOrSection$props$ = itemOrSection.props.textValue) !== null && _itemOrSection$props$ !== void 0 ? _itemOrSection$props$ : typeof itemOrSection.props.children === 'string' ? itemOrSection.props.children : undefined;
-}
-
-/**
- * Get a normalized `textValue` for an item ensuring it is a string.
- * @param item The item
- * @returns A string `textValue` for the item
- */
-function normalizeTextValue(item) {
-  if (typeof item !== 'object') {
-    return String(item);
-  }
-  if (item.props.textValue != null) {
-    return item.props.textValue;
-  }
-  if (typeof item.props.children === 'string') {
-    return item.props.children;
-  }
-  return undefined;
-}
-
-/**
- * Normalize an item or section to an object form.
- * @param itemOrSection item to normalize
- * @returns NormalizedItem or NormalizedSection object
- */
-function normalizeItem(itemOrSection) {
-  if (!isItemOrSection(itemOrSection)) {
-    log.debug(INVALID_ITEM_ERROR_MESSAGE, itemOrSection);
-    throw new Error(INVALID_ITEM_ERROR_MESSAGE);
-  }
-  if (isSectionElement(itemOrSection)) {
-    var _key = normalizeItemKey(itemOrSection);
-    var {
-      title
-    } = itemOrSection.props;
-    var items = normalizeItemList(itemOrSection.props.children).filter(
-    // We don't support nested section elements
-    childItem => !isSectionElement(childItem));
-    return {
-      item: {
-        key: _key,
-        title,
-        items
-      }
-    };
-  }
-  var key = normalizeItemKey(itemOrSection);
-  var content = isItemElement(itemOrSection) ? itemOrSection.props.children : itemOrSection;
-  var textValue = normalizeTextValue(itemOrSection);
-  return {
-    item: {
-      key,
-      content,
-      textValue
-    }
-  };
-}
-
-/**
- * Get normalized items from an item or array of items.
- * @param itemsOrSections An item or array of items
- * @returns An array of normalized items
- */
-export function normalizeItemList(itemsOrSections) {
-  // If already normalized, just return as-is
-  if (isNormalizedItemsWithKeysList(itemsOrSections)) {
-    return itemsOrSections;
-  }
-  var itemsArray = Array.isArray(itemsOrSections) ? itemsOrSections : [itemsOrSections];
-  return itemsArray.map(normalizeItem);
-}
-
 /**
  * Returns a TooltipOptions object or null if options is false or null.
- * @param options
+ * @param options Tooltip options
+ * @param placement Default placement for the tooltip if `options` is set
+ * explicitly to `true`
  * @returns TooltipOptions or null
  */
 export function normalizeTooltipOptions(options) {
+  var placement = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'right';
   if (options == null || options === false) {
     return null;
   }
   if (options === true) {
     return {
-      placement: 'right'
+      placement
     };
   }
   return options;
 }
+
+/**
+ * Convert a selection of `ItemKey`s to a selection of strings.
+ * @param itemKeys The selection of `ItemKey`s
+ * @returns The selection of strings
+ */
+export function itemSelectionToStringSet(itemKeys) {
+  if (itemKeys == null || itemKeys === 'all') {
+    return itemKeys;
+  }
+  return new Set([...itemKeys].map(String));
+}
 //# sourceMappingURL=itemUtils.js.map