feat: Picker - Table support for key + label columns

__mocks__/dh-core.js

@@ -1989,6 +1989,15 @@ class SourceType {
   static Z = 'Z';
 }
 
+class ValueType {
+  static BOOLEAN = 'BOOLEAN';
+  static DATETIME = 'DATETIME';
+  static DOUBLE = 'DOUBLE';
+  static LONG = 'LONG';
+  static NUMBER = 'NUMBER';
+  static STRING = 'STRING';
+}
+
 const dh = {
   FilterCondition: FilterCondition,
   FilterValue: FilterValue,
@@ -2034,6 +2043,7 @@ const dh = {
     DayOfWeek,
   },
   DateWrapper: DateWrapper,
+  ValueType,
   ViewportData,
   VariableType,
   storage: {

packages/code-studio/src/styleguide/Pickers.tsx

@@ -1,10 +1,18 @@
-import React from 'react';
-import { Item, Picker, Section } from '@deephaven/components';
+import React, { useCallback, useState } from 'react';
+import { Picker, PickerItemKey, Section } from '@deephaven/components';
 import { vsPerson } from '@deephaven/icons';
-import { Flex, Icon, Text } from '@adobe/react-spectrum';
+import { Flex, Icon, Item, Text } from '@adobe/react-spectrum';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { sampleSectionIdAndClasses } from './utils';
 
+// Generate enough items to require scrolling
+const items = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'
+  .split('')
+  .map((key, i) => ({
+    key,
+    item: { key: (i + 1) * 100, content: `${key}${key}${key}` },
+  }));
+
 function PersonIcon(): JSX.Element {
   return (
     <Icon>
@@ -14,6 +22,12 @@ function PersonIcon(): JSX.Element {
 }
 
 export function Pickers(): JSX.Element {
+  const [selectedKey, setSelectedKey] = useState<PickerItemKey>();
+
+  const onChange = useCallback((key: PickerItemKey): void => {
+    setSelectedKey(key);
+  }, []);
+
   return (
     // eslint-disable-next-line react/jsx-props-no-spreading
     <div {...sampleSectionIdAndClasses('pickers')}>
@@ -24,7 +38,7 @@ export function Pickers(): JSX.Element {
           <Item>Aaa</Item>
         </Picker>
 
-        <Picker label="Mixed Children Types" tooltip>
+        <Picker label="Mixed Children Types" defaultSelectedKey={999} tooltip>
           {/* eslint-disable react/jsx-curly-brace-presence */}
           {'String 1'}
           {'String 2'}
@@ -76,6 +90,14 @@ export function Pickers(): JSX.Element {
             </Item>
           </Section>
         </Picker>
+
+        <Picker
+          label="Controlled"
+          selectedKey={selectedKey}
+          onChange={onChange}
+        >
+          {items}
+        </Picker>
       </Flex>
     </div>
   );

packages/components/src/spectrum/picker/Picker.tsx

@@ -1,36 +1,57 @@
 import { Key, ReactNode, useCallback, useMemo } from 'react';
+import { DOMRef } from '@react-types/shared';
 import { Flex, Picker as SpectrumPicker, Text } from '@adobe/react-spectrum';
-import { isElementOfType } from '@deephaven/react-hooks';
+import {
+  getPositionOfSelectedItem,
+  findSpectrumPickerScrollArea,
+  isElementOfType,
+  usePopoverOnScrollRef,
+} from '@deephaven/react-hooks';
+import {
+  EMPTY_FUNCTION,
+  PICKER_ITEM_HEIGHT,
+  PICKER_TOP_OFFSET,
+} from '@deephaven/utils';
 import cl from 'classnames';
 import { Tooltip } from '../../popper';
 import {
+  isNormalizedPickerSection,
   NormalizedSpectrumPickerProps,
   normalizePickerItemList,
   normalizeTooltipOptions,
+  NormalizedPickerItem,
   PickerItemOrSection,
-  PickerItemKey,
   TooltipOptions,
-  NormalizedPickerItem,
-  isNormalizedPickerSection,
+  PickerItemKey,
+  getPickerItemKey,
 } from './PickerUtils';
 import { PickerItemContent } from './PickerItemContent';
 import { Item, Section } from '../shared';
 
 export type PickerProps = {
-  children: PickerItemOrSection | PickerItemOrSection[];
+  children:
+    | PickerItemOrSection
+    | PickerItemOrSection[]
+    | NormalizedPickerItem[];
   /** Can be set to true or a TooltipOptions to enable item tooltips */
   tooltip?: boolean | TooltipOptions;
   /** The currently selected key in the collection (controlled). */
   selectedKey?: PickerItemKey | null;
   /** The initial selected key in the collection (uncontrolled). */
   defaultSelectedKey?: PickerItemKey;
+  /** Function to retrieve initial scroll position when opening the picker */
+  getInitialScrollPosition?: () => Promise<number | null>;
   /**
    * 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?: (key: PickerItemKey) => void;
+
+  /** Handler that is called when the picker is scrolled. */
+  onScroll?: (event: Event) => void;
+
   /**
    * Handler that is called when the selection changes.
    * @deprecated Use `onChange` instead
@@ -82,7 +103,10 @@ export function Picker({
   tooltip = true,
   defaultSelectedKey,
   selectedKey,
+  getInitialScrollPosition,
   onChange,
+  onOpenChange,
+  onScroll = EMPTY_FUNCTION,
   onSelectionChange,
   // eslint-disable-next-line camelcase
   UNSAFE_className,
@@ -99,52 +123,116 @@ export function Picker({
   );
 
   const renderItem = useCallback(
-    ({ key, content, textValue }: NormalizedPickerItem) => (
-      // The `textValue` prop gets used to provide the content of `<option>`
-      // elements that back the Spectrum Picker. These are not visible in the UI,
-      // but are used for accessibility purposes, so we set to an arbitrary
-      // 'Empty' value so that they are not empty strings.
-      <Item
-        key={key as Key}
-        textValue={textValue === '' || textValue == null ? 'Empty' : textValue}
-      >
-        <PickerItemContent>{content}</PickerItemContent>
-        {tooltipOptions == null || content === '' ? null : (
-          <Tooltip options={tooltipOptions}>
-            {createTooltipContent(content)}
-          </Tooltip>
-        )}
-      </Item>
-    ),
+    (normalizedItem: NormalizedPickerItem) => {
+      const key = getPickerItemKey(normalizedItem);
+      const content = normalizedItem.item?.content ?? '';
+      const textValue = normalizedItem.item?.textValue ?? '';
+
+      return (
+        <Item
+          // Note that setting the `key` prop explicitly on `Item` elements
+          // causes the picker to expect `selectedKey` and `defaultSelectedKey`
+          // to be strings. It also passes the stringified value of the key to
+          // `onSelectionChange` handlers` regardless of the actual type of the
+          // key. We can't really get around setting in order to support Windowed
+          // data, so we'll need to do some manual conversion of keys to strings
+          // in other places of this component.
+          key={key as Key}
+          // The `textValue` prop gets used to provide the content of `<option>`
+          // elements that back the Spectrum Picker. These are not visible in the UI,
+          // but are used for accessibility purposes, so we set to an arbitrary
+          // 'Empty' value so that they are not empty strings.
+          textValue={textValue === '' ? 'Empty' : textValue}
+        >
+          <>
+            <PickerItemContent>{content}</PickerItemContent>
+            {tooltipOptions == null || content === '' ? null : (
+              <Tooltip options={tooltipOptions}>
+                {createTooltipContent(content)}
+              </Tooltip>
+            )}
+          </>
+        </Item>
+      );
+    },
     [tooltipOptions]
   );
 
+  const getInitialScrollPositionInternal = useCallback(
+    () =>
+      getInitialScrollPosition == null
+        ? getPositionOfSelectedItem({
+            keyedItems: normalizedItems,
+            // TODO: #1890 & deephaven-plugins#371 add support for sections and
+            // items with descriptions since they impact the height calculations
+            itemHeight: PICKER_ITEM_HEIGHT,
+            selectedKey,
+            topOffset: PICKER_TOP_OFFSET,
+          })
+        : getInitialScrollPosition(),
+    [getInitialScrollPosition, normalizedItems, selectedKey]
+  );
+
+  const { ref: scrollRef, onOpenChange: popoverOnOpenChange } =
+    usePopoverOnScrollRef(
+      findSpectrumPickerScrollArea,
+      onScroll,
+      getInitialScrollPositionInternal
+    );
+
+  const onOpenChangeInternal = useCallback(
+    (isOpen: boolean): void => {
+      // Attach scroll event handling
+      popoverOnOpenChange(isOpen);
+
+      onOpenChange?.(isOpen);
+    },
+    [onOpenChange, popoverOnOpenChange]
+  );
+
+  const onSelectionChangeInternal = useCallback(
+    (key: PickerItemKey): void => {
+      // The `key` arg will always be a string due to us setting the `Item` key
+      // prop in `renderItem`. We need to find the matching item to determine
+      // the actual key.
+      const selectedItem = normalizedItems.find(
+        item => String(getPickerItemKey(item)) === key
+      );
+
+      const actualKey = getPickerItemKey(selectedItem) ?? key;
+
+      (onChange ?? onSelectionChange)?.(actualKey);
+    },
+    [normalizedItems, onChange, onSelectionChange]
+  );
+
   return (
     <SpectrumPicker
       // eslint-disable-next-line react/jsx-props-no-spreading
       {...spectrumPickerProps}
+      // The `ref` prop type defined by React Spectrum is incorrect here
+      ref={scrollRef as unknown as DOMRef<HTMLDivElement>}
+      onOpenChange={onOpenChangeInternal}
       UNSAFE_className={cl('dh-picker', UNSAFE_className)}
       items={normalizedItems}
-      // Type assertions are necessary for `selectedKey`, `defaultSelectedKey`,
-      // and `onSelectionChange` due to Spectrum types not accounting for
-      // `boolean` keys
-      selectedKey={selectedKey as NormalizedSpectrumPickerProps['selectedKey']}
-      defaultSelectedKey={
-        defaultSelectedKey as NormalizedSpectrumPickerProps['defaultSelectedKey']
-      }
+      // Spectrum Picker treats keys as strings if the `key` prop is explicitly
+      // set on `Item` elements. Since we do this in `renderItem`, we need to
+      // ensure that `selectedKey` and `defaultSelectedKey` are strings in order
+      // for selection to work.
+      selectedKey={selectedKey?.toString()}
+      defaultSelectedKey={defaultSelectedKey?.toString()}
       // `onChange` is just an alias for `onSelectionChange`
       onSelectionChange={
-        (onChange ??
-          onSelectionChange) as NormalizedSpectrumPickerProps['onSelectionChange']
+        onSelectionChangeInternal as NormalizedSpectrumPickerProps['onSelectionChange']
       }
     >
       {itemOrSection => {
         if (isNormalizedPickerSection(itemOrSection)) {
           return (
             <Section
-              key={itemOrSection.key}
-              title={itemOrSection.title}
-              items={itemOrSection.items}
+              key={getPickerItemKey(itemOrSection)}
+              title={itemOrSection.item?.title}
+              items={itemOrSection.item?.items}
             >
               {renderItem}
             </Section>