docs: picker

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

@@ -6,9 +6,26 @@
 from .basic import component_element
 from .section import SectionElement, Item
 from .item_table_source import ItemTableSource
-from ..elements import BaseElement
+from ..elements import BaseElement, Element
 from .._internal.utils import create_props, unpack_item_table_source
 from ..types import Key
+from .types import (
+    # Layout
+    AlignSelf,
+    CSSProperties,
+    DimensionValue,
+    JustifySelf,
+    LayoutFlex,
+    Number,
+    Position,
+    ValidationBehavior,
+    LabelPosition,
+    Alignment,
+    NecessityIndicator,
+    MenuDirection,
+    FocusEventCallable,
+    KeyboardEventCallable,
+)
 
 PickerElement = BaseElement
 
@@ -27,7 +44,83 @@ def picker(
     selected_key: Key | None = None,
     on_selection_change: Callable[[Key], None] | None = None,
     on_change: Callable[[Key], None] | None = None,
-    **props: Any,
+    is_quiet: bool | None = None,
+    align: Alignment = "start",
+    direction: MenuDirection = "bottom",
+    should_flip: bool = True,
+    menu_width: DimensionValue | None = None,
+    auto_focus: bool | None = None,
+    auto_complete: str | None = None,
+    name: str | None = None,
+    is_open: bool | None = None,
+    default_open: bool | None = None,
+    # items
+    # disabled_keys
+    is_disabled: bool | None = None,
+    is_required: bool | None = None,
+    is_invalid: bool | None = None,
+    validation_behavior: ValidationBehavior | None = None,
+    # validate # omitted because it has synchronous return
+    description: Element | None = None,
+    # error_message # omitted because it has synchronous return
+    label: Element | None = None,
+    placeholder: str | None = None,
+    is_loading: bool | None = None,
+    label_position: LabelPosition = "top",
+    label_alignment: Alignment = "start",
+    necessity_indicator: NecessityIndicator = "icon",
+    contextual_help: Element | None = None,
+    on_open_change: Callable[[bool], None] | 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_load_more # omitted because it has synchronous return
+    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,
+    exclude_from_tab_order: bool | 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,
 ) -> PickerElement:
     """
     A picker that can be used to select from a list. Children should be one of five types:
@@ -54,8 +147,80 @@ def picker(
             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 Picker prop, except items.
+
+        is_quiet: Whether the TextField should be displayed with a quiet style
+        align: Alignment of the menu relative to the input target.
+        direction: Direction in which the menu should open relative to the Picker.
+        should_flip: Whether the menu should flip when it reaches the viewport boundaries.
+        menu_width: Width of the menu. By default, matches width of the trigger. Note that the minimum width of the dropdown is always equal to the trigger's width.
+        auto_focus: Whether the input should be focused on render.
+        auto_complete: Describes the type of autocomplete functionality the input should provide if any.
+        name: Name of the input, used when submitting an HTML form.
+        is_open: Sets the open state of the menu.
+        default_open: Sets the default open state of the menu.
+        is_disabled: Whether the Picker is disabled.
+        is_required: Whether user input on the Picker is required before form submission.
+        is_invalid: Whether the Picker is in an invalid state.
+        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.
+        description: A description for the field. Provides a hint such as specific requirements for what to choose.
+        label: A label for the field.
+        placeholder: Placeholder text for the input.
+        is_loading: Whether the Picker is in a loading state.
+        label_position: The label's overall position relative to the element it is labeling.
+        label_alignment: 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.
+        on_open_change: Handler that is called when the open state changes.
+        on_focus: Handler that is called when the input is focused.
+        on_blur: Handler that is called when the input loses focus.
+        on_focus_change: Handler that is called when the input is focused or blurred.
+        on_key_down: Handler that is called when a key is pressed down.
+        on_key_up: Handler that is called when a key is released.
+        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.
+        exclude_from_tab_order: Whether the element should be excluded from the tab order.
+        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_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 rendered Picker.

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

@@ -162,3 +162,4 @@
     "medium",
     "large",
 ]
+MenuDirection = Literal["bottom", "top"]