docs: list_action_group (#493)

Resolves #483

Changes Implemented:
- Added documentation for list_action_group component

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

@@ -1,17 +1,15 @@
 from __future__ import annotations
 from numbers import Number
 from typing import Any, Callable, Iterable
+
+
 from ..components.spectrum.events import (
     ButtonLabelBehavior,
     Orientation,
     StaticColor,
 )
 from ..elements import Element, BaseElement
-from ..types import (
-    ActionGroupDensity,
-    SelectedKeys,
-    SelectionMode,
-)
+from ..types import ActionGroupDensity, SelectedKeys, SelectionMode, Key, Selection
 from .spectrum.layout import (
     AlignSelf,
     CSSProperties,
@@ -41,7 +39,8 @@ def action_group(
     selected_keys: SelectedKeys | Iterable[str] | None = None,
     default_selected_keys: SelectedKeys | Iterable[str] | None = None,
     on_action: Callable[[str], None] | None = None,
-    on_selection_change: Callable[[str], None] | None = None,
+    on_change: Callable[[Key], None] | None = None,
+    on_selection_change: Callable[[Selection], None] | None = None,
     flex: LayoutFlex | None = None,
     flex_grow: Number | None = None,
     flex_shrink: Number | None = None,
@@ -106,6 +105,9 @@ def action_group(
         selected_keys: The currently selected keys in the collection (controlled).
         default_selected_keys: The initial selected keys in the collection (uncontrolled).
         on_action: Invoked when an action is taken on a child. Especially useful when selectionMode is none. The sole argument key is the key for the item.
+        on_change: Alias of on_selection_change.
+            Handler that is called when the selection changes.
+            The first argument is the selection, the second argument is the key of the list_view item.
         on_selection_change: Handler that is called when the selection 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.
@@ -170,6 +172,7 @@ def action_group(
         selected_keys=selected_keys,
         default_selected_keys=default_selected_keys,
         on_action=on_action,
+        on_change=on_change,
         on_selection_change=on_selection_change,
         flex=flex,
         flex_grow=flex_grow,

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

@@ -1,42 +1,229 @@
 from __future__ import annotations
 
-from typing import Callable, Any, Union
+from numbers import Number
+from typing import Callable, Iterable
 
-from .item import ItemElement
+from .item import Item
 from ..elements import BaseElement, Element
-from .._internal.utils import create_props
-from ..types import Stringable, Selection, Key, ActionKey
+from ..types import (
+    Key,
+    ActionKey,
+    ActionGroupDensity,
+    SelectedKeys,
+    SelectionMode,
+    Selection,
+)
+from .spectrum.layout import (
+    AlignSelf,
+    CSSProperties,
+    DimensionValue,
+    JustifySelf,
+    LayoutFlex,
+    OverflowMode,
+    Position,
+)
+from .spectrum.events import ButtonLabelBehavior, Orientation, StaticColor
 
-ActionGroupItem = Union[Stringable, ItemElement]
 ListActionGroupElement = Element
 
 
-# TODO: pydocs for list_action_group #483
 def list_action_group(
-    *children: ActionGroupItem,
+    *children: Item,
     on_action: Callable[[ActionKey, Key], None] | None = None,
-    on_selection_change: Callable[[Selection, Key], None] | None = None,
     on_change: Callable[[Selection, Key], None] | None = None,
-    **props: Any,
+    is_emphasized: bool | None = None,
+    density: ActionGroupDensity | None = "regular",
+    is_justified: bool | None = None,
+    is_quiet: bool | None = None,
+    static_color: StaticColor | None = None,
+    overflow_mode: OverflowMode | None = "wrap",
+    button_label_behavior: ButtonLabelBehavior | None = "show",
+    summary_icon: Element | None = None,
+    orientation: Orientation | None = "horizontal",
+    disabled_keys: Iterable[str] | None = None,
+    is_disabled: bool | None = None,
+    selection_mode: SelectionMode | None = None,
+    disallow_empty_selection: bool | None = None,
+    selected_keys: SelectedKeys | Iterable[str] | None = None,
+    default_selected_keys: SelectedKeys | Iterable[str] | 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_column: str | None = None,
+    grid_column_start: str | None = None,
+    grid_column_end: str | None = None,
+    grid_row_start: str | None = None,
+    grid_row_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,
+    left: DimensionValue | None = None,
+    right: DimensionValue | None = None,
+    start: DimensionValue | None = None,
+    end: 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,
 ) -> ListActionGroupElement:
     """
     A group of action buttons that can be used to create a list of actions.
     This component should be used within the actions prop of a `ui.list_view` component.
 
     Args:
-        *children: The options to render within the list_action_group.
+        *children: The options to render within the list_action_menu.
         on_action: Handler that is called when an item is pressed.
             The first argument is the key of the action, the second argument is the key of the list_view item.
-        on_selection_change: Handler that is called when the selection changes.
+        on_change: Handler that is called when the selection changes.
             The first argument is the selection, the second argument is the key of the list_view item.
-        on_change: Alias of on_selection_change.
-            Handler that is called when the selection changes.
-            The first argument is the selection, the second argument is the key of the list_view item.
-        **props: Any other ActionGroup prop.
+        is_emphasized: Whether the action buttons should be displayed with emphasized style.
+        density: Sets the amount of space between buttons.
+        is_justified: Whether the ActionButtons should be justified in their container.
+        is_quiet: Whether ActionButtons should use the quiet style.
+        static_color: The static color style to apply. Useful when the ActionGroup appears over a color background.
+        overflow_mode: The behavior of the ActionGroup when the buttons do not fit in the available space.
+        button_label_behaviour: Defines when the text within the buttons should be hidden and only the icon should be shown.
+        summary_icon: The icon displayed in the dropdown menu button when a selectable ActionGroup is collapsed.
+        orientation: The axis the ActionGroup should align with.
+        disabled_keys: A list of keys to disable.
+        is_disabled: Whether the ActionGroup is disabled. Shows that a selection exists, but is not available in that circumstance.
+        selection_mode: The type of selection that is allowed in the collection.
+        disallow_empty_selection: Whether the collection allows empty selection.
+        selected_keys: The currently selected keys in the collection (controlled).
+        default_selected_keys: The initial selected keys in the collection (uncontrolled).
+        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.
+        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 position.
+        top: The top position of the element.
+        bottom: The bottom position of the element.
+        left: The left position of the element.
+        right: The right position of the element.
+        start: The logical start position of the element, depending on layout direction.
+        end: The logical end position of the element, depending on layout direction.
+        z_index: The stacking order for the element
+        is_hidden: Hides the element.
+        id: The unique identifier of the element.
+        aria-label: Defines a string value that labels the current element.
+        aria-labelledby: Identifies the element (or elements) that labels the current element.
+        aria-describedby: Identifies the element (or elements) that describes the object.
+        aria-details: Identifies the element (or elements) that provide a detailed, extended description for the object.
+        UNSAFE_class_name: Set the CSS className for the element. Only use as a last resort. Use style props instead.
+        UNSAFE_style: Set the inline style for the element. Only use as a last resort. Use style props instead.
 
     Returns:
         A ListActionGroup that can be used within the actions prop of a `ui.list_view` component.
     """
-    children, props = create_props(locals())
 
-    return BaseElement("deephaven.ui.components.ListActionGroup", *children, **props)
+    return BaseElement(
+        "deephaven.ui.components.ListActionGroup",
+        *children,
+        on_action=on_action,
+        on_change=on_change,
+        is_emphasized=is_emphasized,
+        density=density,
+        is_justified=is_justified,
+        is_quiet=is_quiet,
+        static_color=static_color,
+        overflow_mode=overflow_mode,
+        button_label_behavior=button_label_behavior,
+        summary_icon=summary_icon,
+        orientation=orientation,
+        disabled_keys=disabled_keys,
+        is_disabled=is_disabled,
+        selection_mode=selection_mode,
+        disallow_empty_selection=disallow_empty_selection,
+        selected_keys=selected_keys,
+        default_selected_keys=default_selected_keys,
+        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_column=grid_column,
+        grid_column_start=grid_column_start,
+        grid_column_end=grid_column_end,
+        grid_row_start=grid_row_start,
+        grid_row_end=grid_row_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,
+        left=left,
+        right=right,
+        start=start,
+        end=end,
+        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,
+    )