{ "cells": [ { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "import panel as pn\n", "import time\n", "\n", "pn.extension()" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The `Placeholder` pane serves as a placeholder for other Panel components. It can be used to display a message while a computation is running, for example.\n", "\n", "#### Parameters:\n", "\n", "For details on other options for customizing the component see the [layout](../../how_to/layout/index.md) and [styling](../../how_to/styling/index.md) how-to guides.\n", "\n", "* **`object`** (Any): The Panel object to display, if object is not already a Panel object it will be converted with the `panel(...)` function.\n", "\n", "___" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The `Placeholder` pane can accept any Panel component as its argument, including other panes." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "placeholder = pn.pane.Placeholder(\"Hello\")\n", "placeholder" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The benefit of using a `Placeholder` is that it allows you to replace the content of the pane without being restricted to a specific type of component. This means you can replace the placeholder with any other pane type, including plots, images, and widgets. You may either use the `update` method:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "placeholder.update(pn.widgets.TextInput(value=\"Hello again!\"))" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "or set the `object` directly:" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "placeholder.object = \"Hello once more!\"" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "If you'd like to temporarily replace the contents, you can use it as a context manager." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "placeholder = pn.pane.Placeholder(\"⏳ Idle\", stylesheets=[\":host { font-size: 24pt }\"])\n", "placeholder" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Upon execution of the cell below, the `Placeholder` pane will display `Starting...`, `Running...`, and `Complete!` in sequence, with a 1 second pause between each message, before finally displaying `Idle` again." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "with placeholder:\n", " placeholder.update(\"🚀 Starting...\")\n", " time.sleep(1)\n", " placeholder.update(\"🏃 Running...\")\n", " time.sleep(1)\n", " placeholder.update(\"✅ Complete!\")\n", " time.sleep(1)" ] } ], "metadata": { "language_info": { "name": "python", "pygments_lexer": "ipython3" } }, "nbformat": 4, "nbformat_minor": 4 }