docs

plugins/ui/src/deephaven/ui/_internal/utils.py

@@ -249,6 +249,19 @@ def _convert_to_java_date(
         )
 
 
+def get_jclass_name(value: Any) -> str:
+    """
+    Get the name of the Java class of the value.
+
+    Args:
+        value: The value to get the Java class name of.
+
+    Returns:
+        The name of the Java class of the value.
+    """
+    return str(value.jclass)[6:]
+
+
 def _jclass_converter(
     value: Instant | ZonedDateTime | LocalDate,  # type: ignore
 ) -> Callable[[Date], Any]:
@@ -261,7 +274,7 @@ def _jclass_converter(
     Returns:
         The converter for the Java date type.
     """
-    return _CONVERTERS[str(value.jclass)[6:]]
+    return _CONVERTERS[get_jclass_name(value)]
 
 
 def _wrap_date_callable(
@@ -282,7 +295,7 @@ def _wrap_date_callable(
     return lambda date: wrap_callable(date_callable)(converter(date))
 
 
-def prioritized_callable_date_converter(
+def _prioritized_callable_converter(
     props: dict[str, Any],
     priority: Sequence[str],
     default_converter: Callable[[Date], Any],
@@ -312,7 +325,8 @@ def convert_date_props(
     simple_date_props: set[str],
     list_date_props: set[str],
     callable_date_props: set[str],
-    callable_date_converter: Callable[[dict[str, Any]], Callable[[Date], Any]],
+    priority: Sequence[str],
+    default_converter: Callable[[Date], Any] = to_j_instant,
 ) -> None:
     """
     Convert date props to Java date types in place.
@@ -323,8 +337,8 @@ def convert_date_props(
         list_date_props: A set of list date keys to convert. The prop value should be a list of Dates.
         callable_date_props: A set of callable date keys to convert.
             The prop value should be a callable that takes a Date.
-        callable_date_converter: A callable that takes the props and
-            returns a date converter to be used for the callable date props.
+        priority: The priority of the props to check.
+        default_converter: The default converter to use if none of the priority props are present.
 
     Returns:
         The converted props.
@@ -339,7 +353,8 @@ def convert_date_props(
                 raise TypeError(f"{key} must be a list of Dates")
             props[key] = [_convert_to_java_date(date) for date in props[key]]
 
-    converter = callable_date_converter(props)
+    # the simple props must be converted before this to simplify the callable conversion
+    converter = _prioritized_callable_converter(props, priority, default_converter)
 
     for key in callable_date_props:
         if props.get(key) is not None:

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

@@ -1,12 +1,30 @@
 from __future__ import annotations
 
 from typing import Any, Sequence, Callable
-from deephaven.time import to_j_instant
+
+from .spectrum import (
+    FocusEventCallable,
+    KeyboardEventCallable,
+    LayoutFlex,
+    Number,
+    DimensionValue,
+    AlignSelf,
+    JustifySelf,
+    Position,
+    AriaPressed,
+    CSSProperties,
+    LabelPosition,
+    Alignment,
+    ValidationBehavior,
+    NecessityIndicator,
+    ValidationState,
+    PageBehavior,
+    HourCycle,
+)
 from ..elements import Element, BaseElement
 from .._internal.utils import (
     create_props,
     convert_date_props,
-    prioritized_callable_date_converter,
 )
 from ..types import Date, Granularity
 
@@ -40,16 +58,12 @@ def _convert_date_picker_props(
         The converted props.
     """
 
-    callable_date_converter = prioritized_callable_date_converter(
-        props, _DATE_PROPS_PRIORITY, to_j_instant
-    )
-
     convert_date_props(
         props,
         _SIMPLE_DATE_PROPS,
         _LIST_DATE_PROPS,
         _CALLABLE_DATE_PROPS,
-        callable_date_converter,
+        _DATE_PROPS_PRIORITY,
     )
 
     return props
@@ -63,16 +77,188 @@ def date_picker(
     max_value: Date | None = None,
     unavailable_values: Sequence[Date] | None = None,
     granularity: Granularity | None = None,
+    page_behavior: PageBehavior | None = None,
+    hour_cycle: HourCycle | None = None,
+    hide_time_zone: bool = False,
+    should_force_leading_zeros: bool | None = None,
+    is_disabled: bool | None = None,
+    is_read_only: bool | None = None,
+    is_required: bool | None = None,
+    validation_behavior: ValidationBehavior | None = None,
+    auto_focus: bool | None = None,
+    label: Element | None = None,
+    description: Element | None = None,
+    error_message: Element | None = None,
+    is_open: bool | None = None,
+    default_open: bool | None = None,
+    name: str | None = None,
+    max_visible_months: int | None = None,
+    should_flip: bool | None = None,
+    is_quiet: bool | None = None,
+    show_format_help_text: bool | None = None,
+    label_position: LabelPosition | None = None,
+    label_align: Alignment | None = None,
+    necessity_indicator: NecessityIndicator | None = None,
+    contextual_help: Element | None = None,
+    validation_state: ValidationState | None = None,
+    on_focus: FocusEventCallable | None = None,
+    on_blur: FocusEventCallable | None = None,
+    on_focus_change: Callable[[bool], None] | None = None,
+    on_key_down: KeyboardEventCallable | None = None,
+    on_key_up: KeyboardEventCallable | None = None,
+    on_open_change: Callable[[bool], None] | None = None,
     on_change: Callable[[Date], None] | None = None,
-    **props: Any,
+    flex: LayoutFlex | None = None,
+    flex_grow: Number | None = None,
+    flex_shrink: Number | None = None,
+    flex_basis: DimensionValue | None = None,
+    align_self: AlignSelf | None = None,
+    justify_self: JustifySelf | None = None,
+    order: Number | None = None,
+    grid_area: str | None = None,
+    grid_row: str | None = None,
+    grid_row_start: str | None = None,
+    grid_row_end: str | None = None,
+    grid_column: str | None = None,
+    grid_column_start: str | None = None,
+    grid_column_end: str | None = None,
+    margin: DimensionValue | None = None,
+    margin_top: DimensionValue | None = None,
+    margin_bottom: DimensionValue | None = None,
+    margin_start: DimensionValue | None = None,
+    margin_end: DimensionValue | None = None,
+    margin_x: DimensionValue | None = None,
+    margin_y: DimensionValue | None = None,
+    width: DimensionValue | None = None,
+    height: DimensionValue | None = None,
+    min_width: DimensionValue | None = None,
+    min_height: DimensionValue | None = None,
+    max_width: DimensionValue | None = None,
+    max_height: DimensionValue | None = None,
+    position: Position | None = None,
+    top: DimensionValue | None = None,
+    bottom: DimensionValue | None = None,
+    start: DimensionValue | None = None,
+    end: DimensionValue | None = None,
+    left: DimensionValue | None = None,
+    right: DimensionValue | None = None,
+    z_index: Number | None = None,
+    is_hidden: bool | None = None,
+    id: str | None = None,
+    aria_label: str | None = None,
+    aria_labelledby: str | None = None,
+    aria_describedby: str | None = None,
+    aria_pressed: AriaPressed | None = None,
+    aria_details: str | None = None,
+    UNSAFE_class_name: str | None = None,
+    UNSAFE_style: CSSProperties | None = None,
 ) -> DatePickerElement:
     """
+    A date picker allows the user to select a date.
 
 
     Args:
-
+        placeholder_value: A placeholder date that influences the format of the
+            placeholder shown when no value is selected.
+            Defaults to today at midnight in the user's timezone.
+        value: The current value (controlled).
+        default_value: The default value (uncontrolled).
+        min_value: The minimum allowed date that a user may select.
+        max_value: The maximum allowed date that a user may select.
+        unavailable_values: A list of dates that cannot be selected.
+        granularity: Determines the smallest unit that is displayed in the date picker.
+            By default, this is `"DAY"` for `LocalDate`, and `"SECOND"` otherwise.
+        page_behavior: Controls the behavior of paging. Pagination either works by
+            advancing the visible page by visibleDuration (default)
+            or one unit of visibleDuration.
+        hour_cycle: Whether to display the time in 12 or 24 hour format.
+            By default, this is determined by the user's locale.
+        hide_time_zone: Whether to hide the time zone abbreviation.
+        should_force_leading_zeros: Whether to always show leading zeros in the
+            month, day, and hour fields.
+            By default, this is determined by the user's locale.
+        is_disabled: Whether the input is disabled.
+        is_read_only: Whether the input can be selected but not changed by the user.
+        is_required: Whether user input is required on the input before form submission.
+        validation_behavior: Whether to use native HTML form validation to prevent form
+            submission when the value is missing or invalid,
+            or mark the field as required or invalid via ARIA.
+        auto_focus: Whether the element should receive focus on render.
+        label: The content to display as the label.
+        description: A description for the field.
+            Provides a hint such as specific requirements for what to choose.
+        error_message: An error message for the field.
+        is_open: Whether the overlay is open by default (controlled).
+        default_open: Whether the overlay is open by default (uncontrolled).
+        name: The name of the input element, used when submitting an HTML form.
+        max_visible_months: The maximum number of months to display at
+            once in the calendar popover, if screen space permits.
+        should_flip: Whether the calendar popover should automatically flip direction
+            when space is limited.
+        is_quiet: Whether the date picker should be displayed with a quiet style.
+        show_format_help_text: Whether to show the localized date format as help
+            text below the field.
+        label_position: The label's overall position relative to the element it is labeling.
+        label_align: The label's horizontal alignment relative to the element it is labeling.
+        necessity_indicator: Whether the required state should be shown as an icon or text.
+        contextual_help: A ContextualHelp element to place next to the label.
+        validation_state: Whether the input should display its "valid" or "invalid" visual styling.
+        on_focus: Function called when the button receives focus.
+        on_blur: Function called when the button loses focus.
+        on_focus_change: Function called when the focus state changes.
+        on_key_down: Function called when a key is pressed.
+        on_key_up: Function called when a key is released.
+        on_open_change: Handler that is called when the overlay's open state changes.
+        on_change: Handler that is called when the value changes.
+            The exact `Date` type will be the same as the type passed to
+            `value`, `default_value` or `placeholder_value`, in that order of precedence.
+        flex: When used in a flex layout, specifies how the element will grow or shrink to fit the space available.
+        flex_grow: When used in a flex layout, specifies how much the element will grow to fit the space available.
+        flex_shrink: When used in a flex layout, specifies how much the element will shrink to fit the space available.
+        flex_basis: When used in a flex layout, specifies the initial size of the element.
+        align_self: Overrides the align_items property of a flex or grid container.
+        justify_self: Specifies how the element is justified inside a flex or grid container.
+        order: The layout order for the element within a flex or grid container.
+        grid_area: The name of the grid area to place the element in.
+        grid_row: The name of the grid row to place the element in.
+        grid_row_start: The name of the grid row to start the element in.
+        grid_row_end: The name of the grid row to end the element in.
+        grid_column: The name of the grid column to place the element in.
+        grid_column_start: The name of the grid column to start the element in.
+        grid_column_end: The name of the grid column to end the element in.
+        margin: The margin to apply around the element.
+        margin_top: The margin to apply above the element.
+        margin_bottom: The margin to apply below the element.
+        margin_start: The margin to apply before the element.
+        margin_end: The margin to apply after the element.
+        margin_x: The margin to apply to the left and right of the element.
+        margin_y: The margin to apply to the top and bottom of the element.
+        width: The width of the element.
+        height: The height of the element.
+        min_width: The minimum width of the element.
+        min_height: The minimum height of the element.
+        max_width: The maximum width of the element.
+        max_height: The maximum height of the element.
+        position: Specifies how the element is positioned.
+        top: The distance from the top of the containing element.
+        bottom: The distance from the bottom of the containing element.
+        start: The distance from the start of the containing element.
+        end: The distance from the end of the containing element.
+        left: The distance from the left of the containing element.
+        right: The distance from the right of the containing element.
+        z_index: The stack order of the element.
+        is_hidden: Whether the element is hidden.
+        id: A unique identifier for the element.
+        aria_label: The label for the element.
+        aria_labelledby: The id of the element that labels the element.
+        aria_describedby: The id of the element that describes the element.
+        aria_pressed: Whether the element is pressed.
+        aria_details: The details for the element.
+        UNSAFE_class_name: A CSS class to apply to the element.
+        UNSAFE_style: A CSS style to apply to the element.
 
     Returns:
+        The date picker element.
     """
     _, props = create_props(locals())
 

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

@@ -4,3 +4,4 @@
 from .button import *
 from .text_field import *
 from .flex import *
+from .date_picker import *

plugins/ui/test/deephaven/ui/test_utils.py

@@ -1,4 +1,5 @@
 import unittest
+
 from .BaseTest import BaseTestCase