Preview Image¶
Show a static image or GIF in the output area before the user runs the code, using the preview attribute.
With a preview image¶
Set preview to an image URL. The image is displayed with a clickable "Run" badge overlay. Clicking the image or the Run button executes the code and replaces the preview with live output:
Without preview (default)¶
When auto-run="false" with no preview and no pre-render, a "Click Run to execute this example" placeholder appears in the output area:
Fence syntax¶
MkDocs:
```{.panel mode="editor" auto-run="false" preview="path/to/screenshot.png"}
import panel as pn
pn.panel("Hello").servable()
```
Sphinx:
.. panel-live::
:auto-run: false
:preview: path/to/screenshot.png
import panel as pn
pn.panel("Hello").servable()
Quarto:
```{.panel-live}
#| auto-run: false
#| preview: path/to/screenshot.png
import panel as pn
pn.panel("Hello").servable()
```
When to use¶
| Scenario | Recommended |
|---|---|
| Streaming / periodic callbacks (can't pre-render) | preview with a screenshot |
| Landing pages (avoid 300 MB download) | preview or pre-render |
| Large example galleries | preview with auto-run="false" |
| PDF / email embeds (no Pyodide) | preview shows a static image |
| Examples that can be pre-rendered | Use pre-render="true" instead |