docs: number field (#505)

Closes #495

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

@@ -4,9 +4,10 @@
 from .button import *
 from .checkbox import *
 from .content import *
+from .contextual_help import *
+from .number_field import *
 from .range_slider import *
 from .slider import *
-from .contextual_help import *
 from .text_field import *
 from .toggle_button import *
 from .flex import *

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

@@ -53,14 +53,6 @@ def form(*children, **props):
     return spectrum_element("Form", *children, **props)
 
 
-def number_field(*children, **props):
-    """
-    Python implementation for the Adobe React Spectrum NumberField component.
-    https://react-spectrum.adobe.com/react-spectrum/NumberField.html
-    """
-    return spectrum_element("NumberField", *children, **props)
-
-
 def switch(*children, **props):
     """
     Python implementation for the Adobe React Spectrum Switch component.

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

@@ -0,0 +1,257 @@
+from __future__ import annotations
+from typing import Any, Callable
+
+from .events import (
+    FocusEventCallable,
+    KeyboardEventCallable,
+)
+from .layout import (
+    AlignSelf,
+    CSSProperties,
+    DimensionValue,
+    JustifySelf,
+    LayoutFlex,
+    Number,
+    Position,
+    LabelPosition,
+    Align,
+)
+from .validate import (
+    TextFieldValidationState,
+    NecessityIndicator,
+)
+from .basic import spectrum_element
+from ...elements import Element
+
+
+def number_field(
+    is_quiet: bool | None = None,
+    hide_stepper: bool | None = None,
+    decrement_aria_label: str | None = None,
+    increment_aria_label: str | None = None,
+    is_wheel_disabled: bool | None = None,
+    # format_options, # omitted because need to connect it to Deephaven formatting options as well
+    is_disabled: bool | None = None,
+    is_read_only: bool | None = None,
+    is_required: bool | None = None,
+    # validation_behaviour, # omitted because validate is not implemented
+    # validate, # omitted because it needs to return a ValidationError synchronously
+    auto_focus: bool | None = None,
+    value: float | None = None,
+    default_value: float | None = None,
+    min_value: float | None = None,
+    max_value: float | None = None,
+    step: float | None = None,
+    label: Any | None = None,
+    description: Any | None = None,
+    error_message: Any | None = None,
+    validation_state: TextFieldValidationState | None = None,
+    name: str | None = None,
+    label_position: LabelPosition = "top",
+    label_align: Align = "start",
+    necessity_indicator: NecessityIndicator = "icon",
+    contextual_help: Any | 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_change: Callable[[float], None] | None = None,
+    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_details: str | None = None,
+    UNSAFE_class_name: str | None = None,
+    UNSAFE_style: CSSProperties | None = None,
+    # missing properties that are clipboard or composition events
+) -> Element:
+    """
+    NumberFields allow users to enter a number, and increment or decrement the value using stepper buttons.
+
+    Args:
+        is_quiet: Whether the input should be displayed with a quiet style
+        hide_stepper: Whether to hide the increment and decrement stepper buttons
+        decrement_aria_label: The aria label for the decrement stepper button. If not provided, the default is "Decrement"
+        increment_aria_label: The aria label for the increment stepper button. If not provided, the default is "Increment"
+        is_wheel_disabled: Whether the input should change with scroll
+        is_disabled: Whether the input should be disabled
+        is_read_only: Whether the input scan be selected but not changed by the user
+        is_required: Whether the input is required before form submission
+        auto_focus: Whether the input should be focused on page load
+        value: The current value of the input
+        default_value: The default value of the input
+        min_value: The minimum value of the input
+        max_value: The maximum value of the input
+        step: The step value for the input
+        label: The label for the input
+        description: A description for the field. Provides a hint such as specific requirements for what to choose.
+        error_message: An error message to display when the field is invalid
+        validation_state: Whether the input should display its "valid" or "invalid" state
+        name: The name of the input, used when submitting an HTML form
+        label_position: The position of the label relative to the input
+        label_align: The alignment of the label relative to the input
+        necessity_indicator: Whether the required state should be shown as an icon or text
+        contextual_help: A ContentualHelp element to place next to the label
+        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_change: Function called when the input value changes
+        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 the element will grow to fit the space available.
+        flex_shrink: When used in a flex layout, specifies how the element will shrink to fit the space available.
+        flex_basis: When used in a flex layout, specifies the initial main size of the element.
+        align_self: Overrides the alignItems property of a flex or grid container.
+        justify_self: Species 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: When used in a grid layout specifies, specifies the named grid area that the element should be placed in within the grid.
+        grid_row: When used in a grid layout, specifies the row the element should be placed in within the grid.
+        grid_column: When used in a grid layout, specifies the column the element should be placed in within the grid.
+        grid_row_start: When used in a grid layout, specifies the starting row to span within the grid.
+        grid_row_end: When used in a grid layout, specifies the ending row to span within the grid.
+        grid_column_start: When used in a grid layout, specifies the starting column to span within the grid.
+        grid_column_end: When used in a grid layout, specifies the ending column to span within the grid.
+        margin: The margin for all four sides of the element.
+        margin_top: The margin for the top side of the element.
+        margin_bottom: The margin for the bottom side of the element.
+        margin_start: The margin for the logical start side of the element, depending on layout direction.
+        margin_end: The margin for the logical end side of the element, depending on layout direction.
+        margin_x: The margin for the left and right sides of the element.
+        margin_y: The margin for the top and bottom sides of the element.
+        width: The width of the element.
+        min_width: The minimum width of the element.
+        max_width: The maximum width of the element.
+        height: The height of the element.
+        min_height: The minimum height of the element.
+        max_height: The maximum height of the element.
+        position: The position of the element.
+        top: The distance from the top of the containing element.
+        bottom: The distance from the bottom of the containing element.
+        left: The distance from the left of the containing element.
+        right: The distance from the right of the containing element.
+        start: The distance from the start of the containing element, depending on layout direction.
+        end: The distance from the end of the containing element, depending on layout direction.
+        z_index: The stack order of the element.
+        is_hidden: Whether the element is hidden.
+        id: The unique identifier of the element.
+        aria_label: The label for the element.
+        aria_labelled_by: The id of the element that labels the current element.
+        aria_described_by: The id of the element that describes the current element.
+        aria_details: The id of the element that provides additional information about the current element.
+        UNSAFE_class_name: A CSS class to apply to the element.
+        UNSAFE_style: A CSS style to apply to the element.
+    """
+
+    return spectrum_element(
+        "NumberField",
+        is_quiet=is_quiet,
+        hide_stepper=hide_stepper,
+        decrement_aria_label=decrement_aria_label,
+        increment_aria_label=increment_aria_label,
+        is_wheel_disabled=is_wheel_disabled,
+        is_disabled=is_disabled,
+        is_read_only=is_read_only,
+        is_required=is_required,
+        auto_focus=auto_focus,
+        value=value,
+        default_value=default_value,
+        min_value=min_value,
+        max_value=max_value,
+        step=step,
+        label=label,
+        description=description,
+        error_message=error_message,
+        validation_state=validation_state,
+        name=name,
+        label_position=label_position,
+        label_align=label_align,
+        necessity_indicator=necessity_indicator,
+        contextual_help=contextual_help,
+        on_focus=on_focus,
+        on_blur=on_blur,
+        on_focus_change=on_focus_change,
+        on_key_down=on_key_down,
+        on_key_up=on_key_up,
+        on_change=on_change,
+        flex=flex,
+        flex_grow=flex_grow,
+        flex_shrink=flex_shrink,
+        flex_basis=flex_basis,
+        align_self=align_self,
+        justify_self=justify_self,
+        order=order,
+        grid_area=grid_area,
+        grid_row=grid_row,
+        grid_row_start=grid_row_start,
+        grid_row_end=grid_row_end,
+        grid_column=grid_column,
+        grid_column_start=grid_column_start,
+        grid_column_end=grid_column_end,
+        margin=margin,
+        margin_top=margin_top,
+        margin_bottom=margin_bottom,
+        margin_start=margin_start,
+        margin_end=margin_end,
+        margin_x=margin_x,
+        margin_y=margin_y,
+        width=width,
+        height=height,
+        min_width=min_width,
+        min_height=min_height,
+        max_width=max_width,
+        max_height=max_height,
+        position=position,
+        top=top,
+        bottom=bottom,
+        start=start,
+        end=end,
+        left=left,
+        right=right,
+        z_index=z_index,
+        is_hidden=is_hidden,
+        id=id,
+        aria_label=aria_label,
+        aria_labelledby=aria_labelledby,
+        aria_describedby=aria_describedby,
+        aria_details=aria_details,
+        UNSAFE_class_name=UNSAFE_class_name,
+        UNSAFE_style=UNSAFE_style,
+    )

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

@@ -1,14 +1,8 @@
 from __future__ import annotations
 from typing import Any, Callable
-from .accessibility import AriaExpanded, AriaHasPopup, AriaPressed
 from .events import (
-    ButtonType,
-    FocusEventCallable,
-    KeyboardEventCallable,
-    PressEventCallable,
     SliderChange,
     SliderChangeCallable,
-    StaticColor,
     Orientation,
 )
 from .layout import (

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

@@ -2,12 +2,8 @@
 from typing import Any, Callable
 from .accessibility import AriaExpanded, AriaHasPopup, AriaAutoComplete
 from .events import (
-    ButtonType,
     FocusEventCallable,
     KeyboardEventCallable,
-    PressEventCallable,
-    StaticColor,
-    Orientation,
 )
 from .layout import (
     AlignSelf,
@@ -21,7 +17,6 @@
     Align,
 )
 from .validate import (
-    InputType,
     TextFieldType,
     TextFieldInputMode,
     TextFieldValidationState,