Improved selectionmode handling (deephaven#366)

bmingles · Apr 17, 2024 · 09b50b0 · 09b50b0
1 parent e8caad1
commit 09b50b0
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 8 deletions.
diff --git a/plugins/ui/src/deephaven/ui/components/list_view.py b/plugins/ui/src/deephaven/ui/components/list_view.py
@@ -9,7 +9,7 @@
 from .list_action_menu import ListActionMenuElement
 from ..elements import BaseElement, Element
 from .._internal.utils import create_props
-from ..types import ColumnName, Stringable, Selection
+from ..types import ColumnName, Stringable, Selection, SelectionMode
 
 ListViewItem = Union[Stringable, ItemElement]
 ListViewElement = Element
@@ -24,6 +24,7 @@ def list_view(
     actions: ListActionGroupElement | ListActionMenuElement | None = None,
     default_selected_keys: Selection | None = None,
     selected_keys: Selection | None = None,
+    selection_mode: SelectionMode | None = "MULTIPLE",
     render_empty_state: Element | None = None,
     on_selection_change: Callable[[Selection], None] | None = None,
     on_change: Callable[[Selection], None] | None = None,

diff --git a/plugins/ui/src/deephaven/ui/types/types.py b/plugins/ui/src/deephaven/ui/types/types.py
@@ -97,7 +97,8 @@ class RowDataValue(CellData):
 ColumnData = List[Any]
 TableData = Dict[ColumnName, ColumnData]
 SearchMode = Literal["SHOW", "HIDE", "DEFAULT"]
-SelectionMode = Literal["CELL", "ROW", "COLUMN"]
+SelectionArea = Literal["CELL", "ROW", "COLUMN"]
+SelectionMode = Literal["SINGLE", "MULTIPLE"]
 Sentinel = Any
 TransformedData = Any
 StringSortDirection = Literal["ASC", "DESC"]

diff --git a/plugins/ui/src/js/src/elements/ListView.tsx b/plugins/ui/src/js/src/elements/ListView.tsx
@@ -1,5 +1,6 @@
 import React, { ReactElement } from 'react';
 import { useSelector } from 'react-redux';
+import type { SelectionMode } from '@react-types/shared';
 import { isElementOfType } from '@deephaven/react-hooks';
 import { getSettings, RootState } from '@deephaven/redux';
 import {
@@ -21,27 +22,51 @@ type WrappedDHListViewJSApiProps = Omit<DHListViewJSApiProps, 'table'> & {
   children: ReactElement<ObjectViewProps>;
 };
 
-export type ListViewProps = (DHListViewProps | WrappedDHListViewJSApiProps) &
+type WrappedDHListViewProps = Omit<DHListViewProps, 'selectionMode'> & {
+  // The spec specifies that selectionMode should be uppercase, but the Spectrum
+  // prop is lowercase. We'll accept either to keep things more flexible.s
+  selectionMode?: SelectionMode | Uppercase<SelectionMode>;
+};
+
+export type ListViewProps = (
+  | WrappedDHListViewProps
+  | WrappedDHListViewJSApiProps
+) &
   SerializedListViewEventProps;
 
-function ListView({ children, ...props }: ListViewProps) {
+function ListView({ children, selectionMode, ...props }: ListViewProps) {
   const settings = useSelector(getSettings<RootState>);
   const listViewProps = useListViewProps(props);
 
   const isObjectView = isElementOfType(children, ObjectView);
   const table = useReExportedTable(children);
 
+  const selectionModeLc = (selectionMode?.toLowerCase() ??
+    'none') as SelectionMode;
+
   if (isObjectView) {
     return (
       table && (
-        // eslint-disable-next-line react/jsx-props-no-spreading
-        <DHListViewJSApi {...listViewProps} table={table} settings={settings} />
+        <DHListViewJSApi
+          // eslint-disable-next-line react/jsx-props-no-spreading
+          {...listViewProps}
+          selectionMode={selectionModeLc}
+          table={table}
+          settings={settings}
+        />
       )
     );
   }
 
-  // eslint-disable-next-line react/jsx-props-no-spreading
-  return <DHListView {...listViewProps}>{children}</DHListView>;
+  return (
+    <DHListView
+      // eslint-disable-next-line react/jsx-props-no-spreading
+      {...listViewProps}
+      selectionMode={selectionModeLc}
+    >
+      {children}
+    </DHListView>
+  );
 }
 
 export default ListView;