Skip to content

Commit eb65d62

Browse files
authored
Update express API docs (#1363)
1 parent 1fb8210 commit eb65d62

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

docs/_quartodoc-express.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,11 @@ quartodoc:
144144
- express.ui.panel_fixed
145145
- express.ui.panel_title
146146
- express.ui.panel_well
147+
- title: Uploads & downloads
148+
desc: Allow users to upload and download files.
149+
contents:
150+
- express.ui.input_file
151+
- express.render.download
147152
- title: Dynamic UI
148153
desc: Dynamically show/hide UI elements.
149154
contents:

shiny/render/_express.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class express(Renderer[None]):
2424
This is similar to :class:`~shiny.render.ui`, except that :class:`~shiny.render.ui`
2525
uses the return value from the the decorated function, whereas this function works
2626
like Shiny Express: as it executes each line of the decorated function, it calls
27-
:func:`~sys.displayhook()` on the result. This has the effet of "capturing" the
27+
:func:`~sys.displayhook()` on the result. This has the effect of "capturing" the
2828
output of each line.
2929
3030
Returns

shiny/render/_render.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,13 @@ class ui(Renderer[TagChild]):
575575
"""
576576
Reactively render HTML content.
577577
578+
Note: If you want to write your function with Shiny Express syntax, where the UI
579+
components are automatically captured as the code is evaluated, use
580+
:func:`~shiny.express.render.express` instead of this function.
581+
582+
This function is used to render HTML content, but it requires that the funciton
583+
returns the content, using Shiny Core syntax.
584+
578585
Returns
579586
-------
580587
:
@@ -589,6 +596,8 @@ class ui(Renderer[TagChild]):
589596
590597
See Also
591598
--------
599+
* :func:`~shiny.express.render.express`
600+
* :func:`~shiny.express.expressify`
592601
* :func:`~shiny.ui.output_ui`
593602
"""
594603

0 commit comments

Comments
 (0)