Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
jnumainville committed Apr 16, 2024
1 parent dbe0abc commit 3547694
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 16 additions & 18 deletions plugins/ui/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -1043,16 +1043,24 @@ ui.section(
) -> SectionElement
```

###### Parameters

| Parameter | Type | Description |
| ----------- |---------------|-------------------------------------------|
| `*children` | `Item` | The options to render within the section. |
| `title` | `str \| None` | The title of the section. |
| `**props` | `Any` | Any other Section prop |

###### ui.list_action_group
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 `ListView` component.

```py
def list_action_group(
*children: ActionGroupItem,
on_action: Callable[[ActionKey, Key], None] | None = None,
on_selection_change: Callable[[Selection, Key], None] | None = None,
**props: Any
*children: ActionGroupItem,
on_action: Callable[[ActionKey, Key], None] | None = None,
on_selection_change: Callable[[Selection, Key], None] | None = None,
**props: Any
) -> ListActionGroupElement:
```

Expand All @@ -1065,17 +1073,16 @@ def list_action_group(
| `**props` | `Any` | Any other [ActionGroup](https://react-spectrum.adobe.com/react-spectrum/ActionGroup.html) prop. |



###### ui.list_action_menu
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 `ListView` component.

```py
def list_action_menu(
*children: ActionMenuItem,
on_action: Callable[[ActionKey, Key], None] | None = None,
on_open_change: Callable[[bool, Key], None] | None = None,
**props: Any
*children: ActionMenuItem,
on_action: Callable[[ActionKey, Key], None] | None = None,
on_open_change: Callable[[bool, Key], None] | None = None,
**props: Any
) -> ListActionMenuElement:
```

Expand All @@ -1087,15 +1094,6 @@ def list_action_menu(
| `on_open_change` | `Callable[[bool, Key], None] \| None` | The first argument is a boolean indicating if the menu is open, the second argument is the key of the list_view item. |
| `**props` | `Any` | Any other [ActionMenu](https://react-spectrum.adobe.com/react-spectrum/ActionMenu.html) prop. |


###### Parameters

| Parameter | Type | Description |
| ----------- | ------- | ----------------------------------------- |
| `*children` | `Item` | The options to render within the section. |
| `title` | `str \| None` | The title of the section. |
| `**props` | `Any` | Any other Section prop |

##### ui.item_table_source

An item table source wraps a Table or PartitionedTable to provide additional information for
Expand Down
2 changes: 2 additions & 0 deletions plugins/ui/src/deephaven/ui/components/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from .list_view import list_view
from .list_action_group import list_action_group
from .list_action_menu import list_action_menu
from .item_table_source import item_table_source

from . import html

Expand All @@ -36,6 +37,7 @@
"icon",
"icon_wrapper",
"item",
"item_table_source",
"illustrated_message",
"list_view",
"list_action_group",
Expand Down

0 comments on commit 3547694

Please sign in to comment.