Skip to content

Commit a424579

Browse files
committed
docs: add supported widgets table to README
1 parent 5393488 commit a424579

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@ Marimo widgets for [Hotdata](https://hotdata.dev): run SQL, browse catalogs, loa
44

55
Requires Python 3.10+, [Marimo](https://marimo.io/), and [hotdata-runtime](https://github.com/hotdata-dev/hotdata-runtime) (installed automatically).
66

7+
## Supported widgets
8+
9+
Importing `hotdata_marimo` registers `mo.ui.hotdata_*` aliases for discoverability.
10+
11+
| Widget | Function | Notes |
12+
|--------|----------|-------|
13+
| SQL editor | `hm.sql_editor(client)` | Returns `.ui` and `.result` |
14+
| Table browser | `hm.table_browser(client)` | Browse connections, schemas, tables, columns |
15+
| Managed databases panel | `hm.databases_panel(client)` | Create catalogs and load parquet files |
16+
| Managed database writer | `hm.managed_database_writer(client)` | Lower-level create/load UI |
17+
| Workspace selector | `hm.workspace_selector_from_env()` | Pick workspace when `HOTDATA_WORKSPACE` is unset |
18+
| Connection picker | `hm.connection_picker(client)` | Dropdown of workspace connections |
19+
| Connection status | `hm.connection_status(client)` | API / workspace health callout |
20+
| Connections panel | `hm.connections_panel(client)` | Status callout plus connection list |
21+
| Query result | `hm.query_result(result)` | Render a `QueryResult` as a table |
22+
| Recent results | `hm.recent_results(client)` | Browse past query results |
23+
| Run history | `hm.run_history(client)` | Recent query runs |
24+
25+
Each widget also has a `mo.ui.hotdata_*` alias (e.g. `mo.ui.hotdata_sql_editor`). Native Marimo SQL cells are supported via `hm.register_hotdata_sql_engine()` and `mo.sql(..., engine=client)`.
26+
727
## Install
828

929
```bash
@@ -104,14 +124,15 @@ return writer.ui
104124

105125
## Other helpers
106126

127+
See [Supported widgets](#supported-widgets) for the full list. Quick examples:
128+
107129
```python
108-
return hm.connection_status(client) # API / workspace callout
109-
return hm.recent_results(client).ui # past query results
110-
return hm.run_history(client) # recent query runs
130+
return hm.connection_status(client)
131+
return hm.connections_panel(client)
132+
return hm.recent_results(client).ui
133+
return hm.run_history(client)
111134
```
112135

113-
Importing `hotdata_marimo` also registers `mo.ui.hotdata_*` aliases (e.g. `mo.ui.hotdata_sql_editor`).
114-
115136
## Demo notebook
116137

117138
```bash

0 commit comments

Comments
 (0)