Skip to content

Commit 892791e

Browse files
committed
Add note about using webtypy
1 parent 7b1d6f9 commit 892791e

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/src/reference/components.md

+2
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ This allows you to embedded any number of client-side PyScript components within
5858

5959
<!--pyscript-setup-required-end-->
6060

61+
{% include-markdown "./template-tag.md" start="<!--pyscript-webtypy-start-->" end="<!--pyscript-webtypy-end-->" %}
62+
6163
{% include-markdown "./template-tag.md" start="<!--pyscript-js-exec-start-->" end="<!--pyscript-js-exec-end-->" %}
6264

6365
{% include-markdown "./template-tag.md" start="<!--pyscript-multifile-start-->" end="<!--pyscript-multifile-end-->" trailing-newlines=false preserve-includer-indent=false %}

docs/src/reference/template-tag.md

+13
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,19 @@ The entire file path provided is loaded directly into the browser, and must have
194194
| `#!python initial` | `#!python str | VdomDict | ComponentType` | The initial HTML that is displayed prior to the PyScript component loads. This can either be a string containing raw HTML, a `#!python reactpy.html` snippet, or a non-interactive component. | `#!python ""` |
195195
| `#!python root` | `#!python str` | The name of the root component function. | `#!python "root"` |
196196

197+
<!--pyscript-webtypy-start-->
198+
199+
??? tip "Get PyScript type hints within your editor via `webtypy`!"
200+
201+
By installing the `webtypy` package, you can get type hints for PyScript components within your editor.
202+
203+
!!! example "Terminal"
204+
205+
```bash linenums="0"
206+
pip install webtypy
207+
```
208+
209+
<!--pyscript-webtypy-end-->
197210
<!--pyscript-js-exec-start-->
198211

199212
??? question "How do I execute JavaScript within PyScript components?"

0 commit comments

Comments
 (0)