Skip to content

Commit

Permalink
Clean up typings for row press a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
mofojed committed Oct 11, 2023
1 parent 47e0396 commit b3bd1bd
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions plugins/ui/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -1215,14 +1215,14 @@ Add a callback for when a press on a row is released (e.g. a row is clicked).
###### Syntax

```py
ui_table.on_row_press(callback: Callable[[int, dict[str, Any]], None]) -> UITable
ui_table.on_row_press(callback: Callable[[RowIndex, RowData], None]) -> UITable
```

###### Parameters

| Parameter | Type | Description |
| ---------- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | `Callable[[int, dict[str, Any]], None]` | The callback function to run when a row is clicked. The first parameter is the row index, and the second is the row data provided in a dictionary where the column names are the keys. |
| Parameter | Type | Description |
| ---------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | `Callable[[RowIndex, RowData], None]` | The callback function to run when a row is clicked. The first parameter is the row index, and the second is the row data provided in a dictionary where the column names are the keys. |

##### on_row_double_press

Expand All @@ -1231,14 +1231,14 @@ Add a callback for when a row is double clicked.
###### Syntax

```py
ui_table.on_row_double_press(callback: Callable[[int, dict[str, Any]], None]) -> UITable
ui_table.on_row_double_press(callback: Callable[[RowIndex, RowData], None]) -> UITable
```

###### Parameters

| Parameter | Type | Description |
| ---------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | `Callable[[int, dict[str, Any]], None]` | The callback function to run when a row is double clicked. The first parameter is the row index, and the second is the row data provided in a dictionary where the column names are the keys. |
| Parameter | Type | Description |
| ---------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | `Callable[[RowIndex, RowData], None]` | The callback function to run when a row is double clicked. The first parameter is the row index, and the second is the row data provided in a dictionary where the column names are the keys. |

##### quick_filter

Expand Down

0 comments on commit b3bd1bd

Please sign in to comment.