initial impl

plugins/ui/src/deephaven/ui/components/__init__.py

@@ -11,6 +11,7 @@
 from .picker import picker
 from .section import section
 from .item import item
+from .list_view import list_view
 
 from . import html
 
@@ -34,6 +35,7 @@
     "icon_wrapper",
     "item",
     "illustrated_message",
+    "list_view",
     "html",
     "number_field",
     "panel",

plugins/ui/src/deephaven/ui/components/list_view.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+from typing import Callable, Any, Union
+
+from deephaven.table import Table
+
+from .item import ItemElement
+from .. import Element
+from ..elements import BaseElement
+from .._internal.utils import create_props
+from ..types import ColumnName, Stringable, Selection
+from .spectrum import ActionButtonElement
+
+ListViewItem = Union[Stringable, ItemElement]
+
+ListViewElement = Element
+
+# TODO: ActionGroupElement and ActionMenuElement are not created yet
+ActionGroupElement = Element
+ActionMenuElement = Element
+
+
+def list_view(
+    *children: ListViewItem | Table,
+    key_column: ColumnName | None = None,
+    label_column: ColumnName | None = None,
+    description_column: ColumnName | None = None,
+    icon_column: ColumnName | None = None,
+    action_buttons: ActionButtonElement
+    | ActionGroupElement
+    | ActionMenuElement
+    | None = None,
+    default_selected_keys: Selection | None = None,
+    selected_keys: Selection | None = None,
+    render_empty_state: Element | None = None,
+    on_selection_change: Callable[[Selection], None] | None = None,
+    on_change: Callable[[Selection], None] | None = None,
+    **props: Any,
+) -> ListViewElement:
+    """
+    A list view that can be used to create a list of items. Children should be one of two types:
+    1. If children are of type `ListViewItem`, they are the list items.
+    2. If children are of type `Table`, the values in the table are the list items.
+        There can only be one child, the `Table`.
+
+
+    Args:
+        *children: The options to render within the list_view.
+        key_column:
+            Only valid if children are of type Table.
+            The column of values to use as item keys. Defaults to the first column.
+        label_column:
+            Only valid if children are of type Table.
+            The column of values to display as primary text. Defaults to the key_column value.
+        description_column:
+            Only valid if children are of type Table.
+            The column of values to display as descriptions.
+        icon_column: Only valid if children are of type Table.
+            The column of values to map to icons.
+        action_buttons:
+            Only valid if any `ListViewItem` children do not already have embedded buttons.
+            The action buttons to render for all elements within the list view.
+            The `on_*` event handlers within the passed object will be modified
+            so that the second argument is the key for the `list_view` item that the buttons are embedded in.
+        default_selected_keys:
+            The initial selected key in the collection (uncontrolled).
+        selected_keys:
+            The currently selected key in the collection (controlled).
+        render_empty_state:
+            Sets what the `list_view` should render when there is no content to display.
+        on_selection_change:
+            Handler that is called when the selection changes.
+        on_change:
+            Alias of `on_selection_change`. Handler that is called when the selection changes.
+        **props:
+            Any other ListView prop, except items, dragAndDropHooks, and onLoadMore.
+
+    Returns:
+        The rendered ListView.
+    """
+    children, props = create_props(locals())
+
+    return BaseElement("deephaven.ui.components.ListView", *children, **props)

plugins/ui/src/deephaven/ui/components/spectrum/action_button.py

@@ -20,6 +20,8 @@
 from .basic import spectrum_element
 from ...elements import Element
 
+ActionButtonElement = Element
+
 
 def action_button(
     *children: Any,
@@ -86,7 +88,7 @@ def action_button(
     aria_details: str | None = None,
     UNSAFE_class_name: str | None = None,
     UNSAFE_style: CSSProperties | None = None,
-) -> Element:
+) -> ActionButtonElement:
     """
     ActionButtons allow users to perform an action. They're used for similar, task-based options within a workflow, and are ideal for interfaces where buttons aren't meant to draw a lot of attention.
     Python implementation for the Adobe React Spectrum ActionButton component: https://react-spectrum.adobe.com/react-spectrum/ActionButton.html

plugins/ui/src/deephaven/ui/types/types.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Literal, Union, List, Tuple, Callable, TypedDict
+from typing import Any, Dict, Literal, Union, List, Tuple, Callable, TypedDict, Sequence
 from deephaven import SortDirection
 
 
@@ -106,3 +106,4 @@ class RowDataValue(CellData):
 Stringable = Union[str, int, float, bool]
 Key = Stringable
 Dependencies = Union[Tuple[Any], List[Any]]
+Selection = Sequence[Key]