Skip to content

Commit 01c5060

Browse files
author
deeleeramone
committed
more docs pages updates
1 parent ab3dcd0 commit 01c5060

4 files changed

Lines changed: 13 additions & 13 deletions

File tree

pywry/docs/docs/guides/html-content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ app.show(content)
2929
| Field | Type | Default | Description |
3030
|---|---|---|---|
3131
| `html` | `str` | *(required)* | The HTML content to render — a fragment or a complete document |
32-
| `css_files` | `list[Path \| str]` | `None` | Paths to CSS files to inject as `<style>` tags |
33-
| `script_files` | `list[Path \| str]` | `None` | Paths to JavaScript files to inject as `<script>` tags |
32+
| `css_files` | `list[Path | str]` | `None` | Paths to CSS files to inject as `<style>` tags |
33+
| `script_files` | `list[Path | str]` | `None` | Paths to JavaScript files to inject as `<script>` tags |
3434
| `inline_css` | `str` | `None` | Raw CSS string injected as a `<style>` tag |
3535
| `json_data` | `dict` | `None` | Data injected as `window.json_data` in the page |
3636
| `init_script` | `str` | `None` | JavaScript code executed after all other scripts load |

pywry/docs/docs/guides/modals.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@ The modal is hidden by default. It renders as an overlay div with a backdrop, an
4646
| `component_id` | `str` | auto | Unique identifier — used in open/close commands |
4747
| `title` | `str` | `"Modal"` | Header text |
4848
| `items` | `list[ToolbarItem]` | `[]` | Components inside the modal body |
49-
| `size` | `"sm"` \| `"md"` \| `"lg"` \| `"xl"` \| `"full"` | `"md"` | Preset width |
50-
| `width` | `str \| None` | `None` | Custom width (overrides `size`) |
49+
| `size` | `"sm" | "md" | "lg" | "xl" | "full"` | `"md"` | Preset width |
50+
| `width` | `str | None` | `None` | Custom width (overrides `size`) |
5151
| `max_height` | `str` | `"80vh"` | Maximum height before scrolling |
5252
| `overlay_opacity` | `float` | `0.5` | Backdrop darkness (0.0–1.0) |
5353
| `close_on_escape` | `bool` | `True` | ESC key closes the modal |
5454
| `close_on_overlay_click` | `bool` | `True` | Clicking outside closes the modal |
5555
| `reset_on_close` | `bool` | `True` | Reset all inputs when closed |
56-
| `on_close_event` | `str \| None` | `None` | Event emitted when modal closes |
56+
| `on_close_event` | `str | None` | `None` | Event emitted when modal closes |
5757
| `open_on_load` | `bool` | `False` | Open immediately on page load |
5858
| `style` | `str` | `""` | Inline CSS on the modal container |
59-
| `script` | `str \| Path \| None` | `None` | JavaScript to inject with the modal |
59+
| `script` | `str | Path | None` | `None` | JavaScript to inject with the modal |
6060
| `class_name` | `str` | `""` | Extra CSS class on the modal container |
6161

6262
### Size Presets

pywry/docs/docs/guides/toasts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ The `alert()` method accepts these parameters:
4343
|:---|:---|:---|:---|
4444
| `message` | `str` | (required) | Toast body text |
4545
| `alert_type` | `str` | `"info"` | One of `info`, `success`, `warning`, `error`, `confirm` |
46-
| `title` | `str \| None` | `None` | Optional header text |
46+
| `title` | `str | None` | `None` | Optional header text |
4747
| `duration` | `int` | `5000` | Auto-dismiss time in milliseconds |
48-
| `callback_event` | `str \| None` | `None` | Event emitted when confirm toast is acknowledged |
48+
| `callback_event` | `str | None` | `None` | Event emitted when confirm toast is acknowledged |
4949
| `position` | `str` | `"top-right"` | Corner position |
5050

5151
### Positions

pywry/docs/docs/mcp/tools.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ The `component_reference` skill is **mandatory** — it contains the only correc
2828

2929
| Event | Payload | Purpose |
3030
|:---|:---|:---|
31-
| `grid:update-data` | `{"data": [...], "strategy": "set\|append\|update"}` | Replace, append, or merge grid rows |
31+
| `grid:update-data` | `{"data": [...], "strategy": "set|append|update"}` | Replace, append, or merge grid rows |
3232
| `grid:request-state` | `{}` | Request grid state (response via `grid:state-response`) |
3333
| `grid:restore-state` | `{"state": {...}}` | Restore a saved grid state |
34-
| `grid:reset-state` | `{"hard": true\|false}` | Soft reset (keeps columns) or hard reset |
34+
| `grid:reset-state` | `{"hard": true|false}` | Soft reset (keeps columns) or hard reset |
3535
| `plotly:update-figure` | `{"data": [...], "layout": {...}}` | Replace chart data and layout |
3636
| `plotly:request-state` | `{}` | Request chart state |
3737
| `pywry:set-content` | `{"id": "...", "text": "..."}` or `{"id": "...", "html": "..."}` | Update a DOM element |
38-
| `pywry:update-theme` | `{"theme": "dark\|light\|system"}` | Switch theme |
38+
| `pywry:update-theme` | `{"theme": "dark|light|system"}` | Switch theme |
3939
| `toolbar:set-value` | `{"componentId": "...", "value": "..."}` | Set a toolbar component's value |
4040
| `toolbar:request-state` | `{}` | Request all toolbar values (response via `toolbar:state-response`) |
4141

@@ -484,8 +484,8 @@ All three parameters are **required**.
484484
| `pywry:set-content` | `{"id": "elementId", "text": "..."}` | Set element `textContent` |
485485
| `pywry:set-content` | `{"id": "elementId", "html": "..."}` | Set element `innerHTML` |
486486
| `pywry:set-style` | `{"id": "elementId", "styles": {"color": "red", "fontSize": "18px"}}` | Update CSS styles |
487-
| `pywry:update-theme` | `{"theme": "dark\|light\|system"}` | Switch theme |
488-
| `pywry:alert` | `{"message": "...", "type": "info\|success\|warning\|error"}` | Show toast |
487+
| `pywry:update-theme` | `{"theme": "dark|light|system"}` | Switch theme |
488+
| `pywry:alert` | `{"message": "...", "type": "info|success|warning|error"}` | Show toast |
489489
| `pywry:navigate` | `{"url": "https://..."}` | Client-side redirect |
490490
| `pywry:download` | `{"content": "...", "filename": "...", "mimeType": "text/plain"}` | Trigger file download |
491491

0 commit comments

Comments
 (0)